rattail/README.md

A Vite+ oriented, AI Agent friendly front-end toolchain

<div align="center">
  <a href="https://rattail.varletjs.org">
    <img src="https://rattail.varletjs.org/logo.svg" width="150">
  </a>
  <h1>Rattail</h1>
  <p>A Vite+ oriented, AI Agent friendly front-end toolchain</p>
  <p>
    <a href="https://rattail.varletjs.org">Documentation</a> |
    <a href="https://github.com/varletjs/rattail/blob/main/README.zh-CN.md">中文介绍</a>
  </p>
  <p>
    <img src="https://img.shields.io/npm/v/rattail?style=flat-square" alt="version">
    <img src="https://img.shields.io/github/stars/varletjs/rattail" alt="stars">
    <img src="https://img.shields.io/npm/l/rattail.svg" alt="license">
    <img src="https://img.shields.io/codecov/c/github/varletjs/rattail" alt="coverage">
  </p>
</div>

---

### Features

- ⚙️ &nbsp; Out-of-the-box [Vite+](https://viteplus.dev) presets covering linting, formatting, staged linting, git hooks, and more.
- 🔧 &nbsp; CLI toolkit for release, changelog, git hooks, commit lint, and API codegen.
- 🧰 &nbsp; 140+ utility functions for general, string, number, array, object, math, and more.
- 🚀 &nbsp; Progressive HTTP client based on axios, with Vue Composition API support.
- 📏 &nbsp; Chainable validation rule factory that adapts to any UI framework.
- 🏷️ &nbsp; Type-safe enum utility.
- 🤖 &nbsp; Provides [Agent Skills](https://github.com/varletjs/rattail/tree/main/skills) for AI coding assistants to understand and use Rattail.
- 🌲 &nbsp; Tree-shakable, lightweight, and fully typed with TypeScript.
- 💪 &nbsp; 90%+ unit test coverage.
- 📄 &nbsp; MIT licensed.

### Installation

```shell
# npm
npm i rattail -S
# yarn
yarn add rattail
# pnpm
pnpm add rattail
```

### Official Docs

- [Documentation Home](https://rattail.varletjs.org)
- [Getting Started](https://rattail.varletjs.org/getting-started)
- [Why Rattail](https://rattail.varletjs.org/why-rattail)
- [Vite+ Presets / CLI Getting Started](https://rattail.varletjs.org/cli/getting-started)
- [Axle Getting Started](https://rattail.varletjs.org/axle/getting-started)
- [Ruler Factory](https://rattail.varletjs.org/ruler/ruler-factory)