Quick Start

Prerequisites

Before installing components, make sure your project has the following:

• React 19+
• Tailwind CSS 4+
• TypeScript

Initialize shadcn

If you haven't already, initialize shadcn in your project:

bunx --bun shadcn@latest init

This creates a components.json file and sets up path aliases.

Configure the registry

Add the @sft-ui registry to your components.json:

{
  "registries": {
    "@sft-ui": {
      "url": "https://sf-ui.com/api/registry/{name}",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Set your token

Add your registry token to .env.local:

REGISTRY_TOKEN=your_token_here

Install a component

You can now install any component from the registry:

bunx shadcn@latest add @sft-ui/button

The CLI will install the component into your project along with any required dependencies.