- Documentation

Registry

A registry in the context of shadcn/ui is a structured collection of components, hooks, and utilities that can be shared and reused across multiple projects. It serves as a centralized source for distributing your design system components in a way that’s compatible with the shadcn-ui CLI.

Docs

Why Use a Registry?

Consistent Component Distribution: Ensures all projects using your design system get the same version of components.

For setup, just place this configuration file in your project root:

javascript

{
  "$schema": "https://ui.shadcn.com/schema.json",
  "style": "default",
  "rsc": true,
  "tsx": true,
  "tailwind": {
    "config": "",
    "css": "app/globals.css",
    "baseColor": "neutral",
    "cssVariables": false,
    "prefix": ""
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/utils/index",
    "ui": "@/components/ui",
    "lib": "@/utils",
    "hooks": "@/hooks"
  },
  "iconLibrary": "radix"
}

How It Works

The registry is a collection of JSON files following shadcn’s schema. Add a component with the following structure:

bash

pnpm dlx shadcn@latest add https://auradesignsystem.com/r/button.json