106k
New

shadcn

PreviousNext

使用 shadcn CLI 将组件添加到您的项目中。

init

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

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

pnpm dlx shadcn@latest init

选项

Usage: shadcn init [options] [components...]
 
initialize your project and install dependencies
 
Arguments:
  components         组件的名称、URL 或本地路径
 
Options:
  -t, --template <template>      使用的模板。（next，next-monorepo）
  -b, --base-color <base-color>  基础颜色。（neutral，gray，zinc，stone，slate）
  -y, --yes                      跳过确认提示。（默认值：true）
  -f, --force                    强制覆盖已有配置。（默认值：false）
  -c, --cwd <cwd>                工作目录，默认当前目录。
  -s, --silent                   静默输出。（默认值：false）
  --src-dir                      创建新项目时使用 src 目录。（默认值：false）
  --no-src-dir                   创建新项目时不使用 src 目录。
  --css-variables                使用 CSS 变量进行主题设置。（默认值：true）
  --no-css-variables             不使用 CSS 变量进行主题设置。
  --no-base-style                不安装 shadcn 基础样式
  -h, --help                     显示命令帮助信息

add

使用 add 命令向项目中添加组件和依赖项。

pnpm dlx shadcn@latest add [component]

选项

Usage: shadcn add [options] [components...]
 
add a component to your project
 
Arguments:
  components         组件的名称、URL 或本地路径
 
Options:
  -y, --yes           跳过确认提示。（默认值：false）
  -o, --overwrite     覆盖已有文件。（默认值：false）
  -c, --cwd <cwd>     工作目录，默认当前目录。
  -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          显示命令帮助信息

view

使用 view 命令在安装前查看注册表中的项目。

pnpm dlx shadcn@latest view [item]

您可以同时查看多个项目：

pnpm dlx shadcn@latest view button card dialog

也可以查看命名空间注册表中的项目：

pnpm dlx shadcn@latest view @acme/auth @v0/dashboard

选项

Usage: shadcn view [options] <items...>
 
view items from the registry
 
Arguments:
  items            要查看的项目名称或 URL
 
Options:
  -c, --cwd <cwd>  工作目录，默认当前目录。
  -h, --help       显示命令帮助信息

search

使用 search 命令从注册表中搜索项目。

pnpm dlx shadcn@latest search [registry]

您可以带查询词进行搜索：

pnpm dlx shadcn@latest search @shadcn -q "button"

或者同时搜索多个注册表：

pnpm dlx shadcn@latest search @shadcn @v0 @acme

list 命令是 search 的别名：

pnpm dlx shadcn@latest list @acme

选项

Usage: shadcn search|list [options] <registries...>
 
search items from registries
 
Arguments:
  registries             要搜索的注册表名称或 URL，名称必须以 @ 开头。
 
Options:
  -c, --cwd <cwd>        工作目录，默认当前目录。
  -q, --query <query>    查询字符串
  -l, --limit <number>   每个注册表显示的最大项目数量（默认值："100"）
  -o, --offset <number>  跳过的项目数（默认值："0"）
  -h, --help             显示命令帮助信息

list

使用 list 命令列出注册表中的所有项目。

pnpm dlx shadcn@latest list @acme

选项

Usage: shadcn list [options] <registries...>
 
list items from registries
 
Arguments:
  registries             要列出的注册表名称或 URL，名称必须以 @ 开头。

选项

Usage: shadcn list [options] <registries...>
 
list items from registries
 
Arguments:
  registries             要列出的注册表名称或 URL，名称必须以 @ 开头。

build

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

pnpm dlx shadcn@latest build

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

选项

Usage: shadcn build [options] [registry]
 
build components for a shadcn registry
 
Arguments:
  registry             registry.json 文件路径（默认值："./registry.json"）
 
Options:
  -o, --output <path>  JSON 文件的输出目录（默认值："./public/r"）
  -c, --cwd <cwd>      工作目录，默认当前目录。
  -h, --help           显示命令帮助信息

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

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