Skip to content
Docs / components.json

Get started

components.json

Tell the shadcn CLI who you are once, and every @aicanvas install in the project is authenticated.

The @aicanvas registry

@aicanvas is listed in the official shadcn registry directory, so the CLI knows where to find it with no setup. What it needs from you is a token, so it can install for your account.

Add your token

  1. Sign in and copy your personal token from Account settings.
  2. Put it in .env.local in the project root:
.env.local
AICANVAS_TOKEN=your-token
  1. Add the registry to components.json. The CLI reads the token from the environment, so the file itself holds no secret:
components.json
{
  "registries": {
    "@aicanvas": {
      "url": "https://aicanvas.me/r/{name}.json",
      "params": { "token": "${AICANVAS_TOKEN}" }
    }
  }
}

Merge the registries key into the file you already have; leave the rest as it is. From now on, npx shadcn@latest add @aicanvas/<name> installs for your account.

Keep the token out of git

.env.local is ignored by git in a standard Next.js project. Check that your project ignores it too before you commit. Your agent may read the token from there; it only identifies your account to the registry.

Premium items

The same token unlocks Premium components, Andromeda Pro, its templates and the AI Brain when your account has Premium. Nothing else changes in the setup.

Without a token, an install writes a short placeholder file titled "(free account required)" instead of the component.