UNPKG

ultracite

Version:

The AI-ready formatter that helps you write and generate code faster.

www.ultracite.ai

haydenbleasel/ultracite

89 lines (57 loc) • 4.3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# Ultracite **A production-grade, zero-configuration preset for ESLint, Biome, and Oxlint.** Ultracite helps you and your AI models write consistent, type-safe code without the hassle of configuration. Pick your preferred toolchain, run one command, and get hundreds of battle-tested rules wired up in seconds — across single repos and monorepos alike. <div> <img src="https://img.shields.io/npm/dy/ultracite" alt="" /> <img src="https://img.shields.io/npm/v/ultracite" alt="" /> <img src="https://img.shields.io/github/license/haydenbleasel/ultracite" alt="" /> </div> ## Quick Start ```sh npx ultracite init ``` The interactive setup guides you through choosing your formatter/linter, framework, editor, and AI agents, then installs and configures everything for you. Re-run it any time to adjust your setup. > Prefer a different package manager? Ultracite detects yours automatically, or you can run it with `pnpm dlx`, `yarn dlx`, or `bunx`. ## Commands | Command | Description | | --- | --- | | `ultracite init` | Initialize Ultracite in the current directory (interactive by default). | | `ultracite check [files...]` | Lint without writing changes. Unknown flags are passed through to the underlying linter. | | `ultracite fix [files...]` | Lint and auto-fix. Unknown flags are passed through to the underlying linter. | | `ultracite doctor` | Verify your Ultracite setup and diagnose configuration issues. | `check` and `fix` accept an optional list of files or globs; omit them to run against the whole project. Add `-v` / `--version` or `-h` / `--help` for CLI details. Common `init` flags for non-interactive / CI use: | Flag | Description | | --- | --- | | `--linter <linter>` | Toolchain to configure (Biome, ESLint, or Oxlint). | | `--pm <pm>` | Package manager to use. | | `--editors <editors...>` | Editors to configure (use `universal` for `.vscode/settings.json`). | | `--agents <agents...>` | AI agents to enable (use `universal` for `AGENTS.md`). | | `--frameworks <frameworks...>` | Frameworks in use, for framework-aware rules. | | `--js-plugins <plugins...>` | Optional Oxlint JS plugins to enable (`eslint-plugin-github`, `eslint-plugin-sonarjs`, `oxlint-plugin-react-doctor`). | | `--type-aware` | Enable type-aware linting. | | `--install-skill` | Install the reusable Ultracite skill after setup. | | `--skip-install` | Configure without installing dependencies. | | `--quiet` | Suppress interactive prompts (auto-enabled in CI). | See the [CLI reference](https://ultracite.ai/) for the full, current list of options. ## Supported Tools - **Biome** — All-in-one formatting and linting in a single fast binary. - **ESLint + Prettier + Stylelint** — The most mature ecosystem with the largest plugin support. - **Oxlint + Oxfmt** — Rust-based tooling that runs dramatically faster than ESLint, part of the Oxc ecosystem. ## Key Features ### ⚡ Subsecond Performance Built around Rust-based tooling for near-instant analysis. On-save checks feel seamless and stay out of your way. ### 🎯 Zero-Config by Design Hundreds of preconfigured rules tuned for modern JavaScript and TypeScript. It works out of the box, and you can override anything when you need to. ### 🤖 AI-Ready Generate ruleset and context files for a wide range of AI agents — Claude Code, GitHub Copilot, Cursor, Gemini, and many more — so humans and models share one consistent style. ### 🏗️ Monorepo Ready One unified toolchain configuration across every package and app, eliminating duplicate config files while keeping standards consistent. ## Using the presets directly Beyond the CLI, Ultracite publishes ready-made config presets you can extend in your own setup (Biome, ESLint, Oxlint, Oxfmt, Prettier, and Stylelint). `ultracite init` wires these up for you; if you'd rather reference them by hand, the [configuration docs](https://ultracite.ai/) list the exact import paths and extension points for each toolchain. ## Documentation Full setup guides, configuration options, rule references, framework and editor integrations, and examples live in the docs: - **Website:** https://www.ultracite.ai/ - **Issues & discussions:** https://github.com/haydenbleasel/ultracite ## License MIT © [Hayden Bleasel](https://github.com/haydenbleasel)