Skip to content

参考

基于 shadcn-ui/ui 官方 skill 的 SKILL.md、rules/ 与 CLI 编写。

速查

  • skill 目录:SKILL.md + rules/(styling/forms/composition/icons/chat)+ cli.md/registry.md/mcp.md/customization.md + agents/assets/evals
  • CLInpx shadcn@latest info / docs / search / add / preset / apply / init
  • MCP:shadcn MCP(ui.shadcn.com/docs/mcp)接 registry
  • 配套 skillmigrate-radix-to-base
  • 官方:shadcn-ui/ui,MIT,★119k

skill 目录结构

文件/目录内容
SKILL.md入口:原则 + 6 大 Critical Rules + Key Patterns + 组件选择表(~19KB)
rules/styling.mdclassName/gap/size/dark/cn/z-index 错误对
rules/forms.mdFieldGroup/Field/InputGroup/ToggleGroup/校验
rules/composition.mdGroup 嵌套/触发/Title/Card/Tabs/Avatar
rules/icons.mddata-icon/尺寸/对象传入
rules/chat.mdMessageScroller/Message/Bubble/Attachment
cli.md / registry.md / mcp.md / customization.mdCLI / registry / MCP / 定制
agents/ assets/ evals/代理 / 资源 / 评测

CLI 命令

命令作用
shadcn@latest info --json项目配置 + 已装组件
shadcn@latest docs <component>组件文档 + 示例 URL
shadcn@latest search查 registry(含社区)现有组件
shadcn@latest add <component>加组件源码进项目
shadcn@latest preset decode/url/open/resolve <code>preset 代码解析(别手拼
shadcn@latest apply <code>既有项目应用 preset
shadcn@latest init --preset <code>初始化带 preset

运行器按项目 packageManagernpx / pnpm dlx / bunx --bun

4 原则

  1. 先用现有组件(search registry)
  2. 组合而非重造
  3. 内建 variant 优先(variant/size
  4. 语义色(bg-primarybg-blue-500

Key Patterns 速览

场景正确
表单布局FieldGroup + Field(非 div+Label
校验Field data-invalid + 控件 aria-invalid
Button 图标<Icon data-icon="inline-start" />(无尺寸类)
间距flex flex-col gap-4(非 space-y-4
等宽高size-10(非 w-10 h-10
状态色Badge variant / 语义 token

shadcn MCP

ui.shadcn.com/docs/mcp——一个 MCP URL 接 shadcn.io registry,AI 直接 search/browse/install 每个 block/icon/example。与 skill(规则 + 项目上下文)互补。

安装与许可

  • skill:装入 agent skills 目录(user-invocable: false,自动触发;allowed-toolsshadcn@latest CLI)
  • MCP:接 shadcn MCP URL
  • 许可:MIT,源 shadcn-ui/uiskills/shadcn/
  • 贡献:改 shadcn-ui/ui 提 PR

资源链接