文档
shadcn
shadcn
使用 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 the components to add or a url to the component.
Options:
-y, --yes skip confirmation prompt. (default: true)
-d, --defaults, use default configuration. (default: false)
-f, --force force overwrite of existing configuration. (default: false)
-c, --cwd <cwd> the working directory. defaults to the current directory. (default: "/Users/shadcn/Desktop")
-s, --silent mute output. (default: false)
--src-dir use the src directory when creating a new project. (default: false)
--no-src-dir do not use the src directory when creating a new project.
--css-variables use css variables for theming. (default: true)
--no-css-variables do not use css variables for theming.
-h, --help display help for command
add
使用 add
命令向你的项目添加组件和依赖项。
pnpm dlx shadcn@latest add [component]
选项
Usage: shadcn add [options] [components...]
add a component to your project
Arguments:
components the components to add or a url to the component.
Options:
-y, --yes skip confirmation prompt. (default: false)
-o, --overwrite overwrite existing files. (default: false)
-c, --cwd <cwd> the working directory. defaults to the current directory. (default: "/Users/shadcn/Desktop")
-a, --all add all available components (default: false)
-p, --path <path> the path to add the component to.
-s, --silent mute output. (default: false)
--src-dir use the src directory when creating a new project. (default: false)
--no-src-dir do not use the src directory when creating a new project.
--css-variables use css variables for theming. (default: true)
--no-css-variables do not use css variables for theming.
-h, --help display help for command
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 path to registry.json file (default: "./registry.json")
Options:
-o, --output <path> destination directory for json files (default: "./public/r")
-c, --cwd <cwd> the working directory. defaults to the current directory. (default:
"/Users/shadcn/Code/shadcn/ui/packages/shadcn")
-h, --help display help for command
要自定义输出目录,请使用 --output
选项。
pnpm dlx shadcn@latest build --output ./public/registry