Installation

Connect your project to the Breeze UI registry and install components and templates.

Breeze UI is a private shadcn registry. You install with the shadcn CLI, and the files are copied into your project, so you own and can change every line.

Requirements

A Next.js project set up with shadcn/ui and Tailwind CSS v4. If you don't have one yet:

pnpm dlx shadcn@latest init

Add the registry

Add @breeze to the registries in your components.json:

components.json
{  "registries": {    "@breeze": {      "url": "https://<breeze-ui-site>/r/{name}.json",      "headers": {        "Authorization": "Bearer ${BREEZE_TOKEN}"      }    }  }}

Add your token

Put the token from your purchase in .env.local. The shadcn CLI reads it from there and sends it with every request.

.env.local
BREEZE_TOKEN=bz_your_token_here

Keep the token out of git. .env.local is already ignored in new Next.js projects.

Install

A component:

pnpm dlx shadcn@latest add @breeze/button

A template. It adds the page at /templates/<name>, its sections under components/templates/<name>, and its theme to your globals.css:

pnpm dlx shadcn@latest add @breeze/hairline

See everything available:

pnpm dlx shadcn@latest search @breeze

Troubleshooting

  • Missing Breeze UI token (401): BREEZE_TOKEN isn't set. Check .env.local and that components.json uses ${BREEZE_TOKEN} exactly.
  • Token isn't valid (403): the token was mistyped or has been revoked.
  • No item called … (404): check the name with shadcn search @breeze.