CLI
Commands in @aura-design/cli for initializing Aura, theming, spacing migration, and blueprint scaffolding.
@aura-design/cli is the on-ramp for Aura. It wraps Next.js scaffolding and the shadcn CLI with Aura registries, tokens, rules, skills, and optional project tooling.
Invoke it with:
pnpm dlx @aura-design/cli@latest <command>The published binary name is aura.
Quick start
New Next.js app with Aura fixtures:
pnpm dlx @aura-design/cli@latest initExisting Next.js app (skips create-next-app):
pnpm dlx @aura-design/cli@latest setup
# or
pnpm dlx @aura-design/cli@latest setup --dir ./apps/webSee also Installation for adding every registry component via all.txt.
Commands
init
Creates a Next.js app with create-next-app, then applies Aura to the new (or current) project root:
- Writes
components.jsonwith@auraand@aura-devregistries - Generates light/dark Radix scales into
globals.css - Runs
shadcn addfor@aura/class-names,@aura/page-get-starter,@aura/css-main,@aura/rules, and@aura/skills - Runs the same scaffolding as
blueprint, including gdp-ts proofs
pnpm dlx @aura-design/cli@latest initsetup
Same Aura apply step as init, for a project that already has a package.json. Does not run create-next-app.
| Option | Description |
|---|---|
-d, --dir <path> | Project root (default: current working directory) |
pnpm dlx @aura-design/cli@latest setup --dir .link
Downloads the canonical Aura components.json (shadcn config with @aura registry URLs) into your project. Useful when you only need the registry config, not a full setup.
| Option | Description |
|---|---|
-o, --output <path> | Output path relative to cwd (default: components.json) |
pnpm dlx @aura-design/cli@latest link
pnpm dlx @aura-design/cli@latest link --output ./apps/web/components.jsonblueprint [projectDir]
Scaffolds Aura project tooling into any repo with a package.json:
wiki/bruno-*andwiki/obsidian-*(suffix from the package name, first segment stripped).cursor/skills/generate-brand-images/(identity-aware Gemini landing images)scripts/preflight.tssonar-project.propertiesplus Sonar-related scripts / devDependencies.gitignoreand.env.exampleentries for Sonar / Gemini keys- gdp-ts:
@gdp-ts/core, the ESLint preset, the agent skill, atypecheckscript when one is missing, and starter proofs (session, org role, project role, plan entitlement, anddeleteProject)
Also runs automatically at the end of init and setup.
| Option | Description |
|---|---|
-f, --force | Overwrite bootstrap files and scripts/preflight.ts if they exist |
--suffix <string> | Override wiki folder suffix |
pnpm dlx @aura-design/cli@latest blueprint
pnpm dlx @aura-design/cli@latest blueprint ./apps/web --force --suffix my-appNote: The docs page Agent blueprint is an agent runbook (
Ejecuta+ URL). It is not this CLI command, though the runbook may invokeaura blueprintwhen scaffolding is missing.
colors
Regenerates globals.css from accent, gray, and background hex values (Radix-style 12-step scales, light and dark). Pass flags or answer prompts.
| Option | Description |
|---|---|
--accent <hex> | Accent color |
--gray <hex> | Gray / neutral base |
--background <hex> | App background |
pnpm dlx @aura-design/cli@latest colors --accent "#964CE1" --gray "#6b7394" --background "#FFFFFF"Looks for app/globals.css, src/app/globals.css, styles/globals.css, or src/styles/globals.css (creates app/globals.css if none exist).
typography generate
Interactive prompts for body size, small size, and a headline scale (ratio or explicit h6–h1). Writes a custom typography.css aligned with Aura’s fluid clamp() philosophy.
pnpm dlx @aura-design/cli@latest typography generatespacing [target]
Rewrites Tailwind spacing utilities in .tsx files from the default 4px mental model to the closest 13px-based token (Aura’s --spacing).
| Option | Description |
|---|---|
-d, --dir <directory> | Scan root when target is omitted (default: .) |
pnpm dlx @aura-design/cli@latest spacing
pnpm dlx @aura-design/cli@latest spacing ./components
pnpm dlx @aura-design/cli@latest spacing --dir ./apps/webAdding components
After init or setup, install individual registry items with the shadcn CLI and the @aura namespace:
pnpm dlx shadcn@latest add @aura/buttonThere is no Aura command that adds every component. Use the newline-delimited list at https://auradesignsystem.com/all.txt.
Related
- Installation — shortest path to a working Aura app
- Registry — how
@aura/*items are distributed - Namespace —
@auravs@aura-devincomponents.json - MCP — browse and install registries from Cursor
- Agent blueprint — agent runbook for existing projects
- gdp-ts — proof-carrying authz installed by
initandblueprint