Getting started

aq-ui installs editable source into React applications. There is no monolithic component runtime to wrap your project.

Requirements

React 18.3 or 19, Tailwind CSS 4, and a project built with Next.js, Vite, or React Router.

Initialize

bash

pnpm dlx aq-ui@alpha initpnpm dlx aq-ui@alpha init

The command detects your package manager and aliases, creates components.json, installs the neutral token foundation, and records source hashes.

components.json

{
  "$schema": "https://ui.shadcn.com/schema.json",
  "style": "aq-neutral",
  "rsc": true,
  "tsx": true,
  "tailwind": {
    "css": "src/app/globals.css",
    "cssVariables": true
  },
  "aliases": {
    "components": "@/components",
    "ui": "@/components/ui",
    "hooks": "@/hooks",
    "lib": "@/lib",
    "utils": "@/lib/utils"
  }
}1{2  "$schema": "https://ui.shadcn.com/schema.json",3  "style": "aq-neutral",4  "rsc": true,5  "tsx": true,6  "tailwind": {7    "css": "src/app/globals.css",8    "cssVariables": true9  },10  "aliases": {11    "components": "@/components",12    "ui": "@/components/ui",13    "hooks": "@/hooks",14    "lib": "@/lib",15    "utils": "@/lib/utils"16  }17}

Add open code

bash

pnpm dlx aq-ui@alpha add button dialog data-gridpnpm dlx aq-ui@alpha add button dialog data-grid

Only declared transitive registry items and npm packages are installed. Local edits are protected during diff, update, and remove operations.

Continue with the component catalog, hook catalog, or CLI reference.