Docs
shadcn

shadcn

使用 shadcn CLI 向您的项目添加组件。

init

使用 init 命令为新项目初始化配置和依赖关系。

init 命令安装依赖关系，添加 cn 工具并为项目配置 CSS 变量。

pnpm dlx shadcn@latest init

选项

用法: shadcn init [选项] [组件...]

初始化您的项目并安装依赖关系

参数:
  components         要添加的组件或组件的 URL。

选项:
  -y, --yes           跳过确认提示。 (默认: true)
  -d, --defaults      使用默认配置。 (默认: false)
  -f, --force         强制覆盖现有配置。 (默认: false)
  -c, --cwd <cwd>     工作目录。默认为当前目录。 (默认: "/Users/shadcn/Desktop")
  -s, --silent        静音输出。 (默认: false)
  --src-dir           创建新项目时使用 src 目录。 (默认: false)
  --no-src-dir        创建新项目时不使用 src 目录。
  --css-variables     使用 css 变量进行主题设置。 (默认: true)
  --no-css-variables  不使用 css 变量进行主题设置。
  -h, --help          显示命令帮助

add

使用 add 命令向您的项目添加组件和依赖关系。

pnpm dlx shadcn@latest add [组件]

选项

用法: shadcn add [选项] [组件...]

向您的项目添加一个组件

参数:
  components         要添加的组件或组件的 URL。

选项:
  -y, --yes           跳过确认提示。 (默认: false)
  -o, --overwrite     覆盖现有文件。 (默认: false)
  -c, --cwd <cwd>     工作目录。默认为当前目录。 (默认: "/Users/shadcn/Desktop")
  -a, --all           添加所有可用组件 (默认: false)
  -p, --path <path>   添加组件的路径。
  -s, --silent        静音输出。 (默认: false)
  --src-dir           创建新项目时使用 src 目录。 (默认: false)
  --no-src-dir        创建新项目时不使用 src 目录。
  --css-variables     使用 css 变量进行主题设置。 (默认: true)
  --no-css-variables  不使用 css 变量进行主题设置。
  -h, --help          显示命令帮助

build

使用 build 命令生成注册表 JSON 文件。

pnpm dlx shadcn@latest build

此命令读取 registry.json 文件并在 public/r 目录中生成注册表 JSON 文件。

选项

用法: shadcn build [选项] [registry]

为 shadcn 注册表构建组件

参数:
  registry             registry.json 文件的路径 (默认: "./registry.json")

选项:
  -o, --output <path>  JSON 文件的目标目录 (默认: "./public/r")
  -c, --cwd <cwd>      工作目录。默认为当前目录。 (默认:
                       "/Users/shadcn/Code/shadcn/ui/packages/shadcn")
  -h, --help           显示命令帮助

要自定义输出目录，请使用 --output 选项。

pnpm dlx shadcn@latest build --output ./public/registry
Dark modeMonorepo