用途:shadcn 是构建 UI、组件与设计系统的框架,组件以源码形式通过 CLI 加入用户项目,便于直接修改与组合。
主要能力:提供项目上下文(配置与已安装组件)、组件文档与示例 URL、注册表搜索、组件添加与更新、预设与模板初始化,以及样式、表单、组合、图标等规则参考。
使用方式:所有 CLI 命令按项目包管理器选择运行器,如 npx shadcn@latest、pnpm dlx shadcn@latest 或 bunx --bun shadcn@latest。常用命令包括 npx shadcn@latest info --json 获取项目上下文,npx shadcn@latest docs <component> 获取文档与示例 URL,npx shadcn@latest search 搜索注册表,npx shadcn@latest add 添加组件,npx shadcn@latest view 查看未安装项,npx shadcn@latest add --dry-run 与 --diff 预览更新。初始化可用 npx shadcn@latest init --preset <code>,模板含 next、vite、start、react-router、astro、laravel,部分支持 --monorepo。
适用场景:需要按现有组件优先、组合而非重写的方式搭建界面,如设置页用 Tabs + Card + 表单控件,仪表盘用 Sidebar + Card + Chart + Table。
限制与注意:需遵循语义色、gap-* 间距、size-* 尺寸、data-icon 图标等规则;表单用 FieldGroup + Field;覆盖层需标题;添加第三方注册表组件后需检查并修正导入路径与图标库;更新组件应使用 CLI 的 --dry-run 与 --diff,不得手动抓取 GitHub 原始文件;切换预设需先询问用户;添加区块时注册表必须明确,不可替用户默认选择。具体收费、价格与效果暂未提供。