# @ant-design/cli 中文文档 规范地址：https://npmcn.com/package/%40ant-design/cli/ 版本：6\.7\.0 npm 元数据更新时间：2026-11-04T04:44:44.532Z 中文译文更新时间：2026-11-06T06:01:16.299Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40ant-design/cli 原文对照：https://npmcn.com/package/%40ant-design/cli/?lang=original 项目主页：https://github.com/ant-design/ant-design-cli#readme 源码仓库：https://github.com/ant-design/ant-design-cli ## 关键信息（来自 npm 元数据） - 包体积（解压后）：29.7 MB，78 个文件 - 模块格式：ES Module - TypeScript 类型：包内自带 - Node.js 要求：\>=20\.0\.0 - 运行依赖：6 个 - 首次发布：2026-03-17T02:57:04.175Z - 最新版本发布：2026-11-04T04:44:44.150Z - 近 30 天下载量：75037（2026-10-06 至 2026-11-04，npm 官方下载统计） - 已发布版本数：30（近 12 个月 30 个） ## 中文简介 用于查询蚂蚁知识和分析蚂蚁在项目中的使用情况的CLI工具 ## 安装 ```sh npm install @ant-design/cli ``` 也可以使用：`pnpm add @ant-design/cli`、`yarn add @ant-design/cli`、`bun add @ant-design/cli` ## README ![Ant Design](https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg) # Ant Design CLI **命令行上的 Ant Design。** 查询组件知识、分析项目用量、指导版本迁移 — 完全离线。 [![npm version](https://img.shields.io/npm/v/@ant-design/cli?color=blue&label=npm)](https://www.npmjs.com/package/@ant-design/cli) [![npm downloads](https://img.shields.io/npm/dm/@ant-design/cli?color=blue)](https://www.npmjs.com/package/@ant-design/cli) [![CI](https://github.com/ant-design/ant-design-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/ant-design/ant-design-cli/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/ant-design/ant-design-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/ant-design/ant-design-cli) [![install size](https://packagephobia.com/badge?p=@ant-design/cli)](https://packagephobia.com/result?p=@ant-design/cli) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://npmcn.com/package/%40ant-design/cli/LICENSE) [English](https://npmcn.com/package/%40ant-design/cli/README.md) · [中文](https://npmcn.com/package/%40ant-design/cli/README.zh-CN.md) · [更新日志](https://npmcn.com/package/%40ant-design/cli/CHANGELOG.zh-CN.md) ## 🤔 为什么 Code Agent（Claude Code、Codex、Gemini CLI）在拥有即时 API 数据访问能力时，能写出更好的 antd 代码。这个 CLI 正是为此而生 — **antd v3 / v4 / v5 / v6 的每个 Prop、Token、Demo 和 Changelog 条目**，本地打包，毫秒级查询。 ```bash npx skills add ant-design/ant-design-cli # 安装为 Agent Skill ``` ## ✨ 亮点 - 📦 **完全离线** — 所有元数据随包安装，无需网络请求，无延迟，无 API Key。 - 🎯 **版本精确** — 跨 v3/v4/v5/v6 的 55+ 小版本快照。查询 `antd@5.3.0` 的精确 API，而非仅 "最新 v5"。 - 🤖 **Agent 优化** — 所有命令支持 `--format json`。结构化错误码与修复建议。stdout/stderr 严格分离。 - 🌍 **双语输出** — 每个组件名、描述和文档均有中英文。通过 `--lang zh` 切换。 - 🔮 **智能纠错** — 输入 `Buttn`？CLI 基于 Levenshtein 距离建议 `Button`，优先匹配首字母相同的候选。 - 🧩 **18 条命令** — 从 Prop 查询到项目级 Lint，从 Design Token 到跨版本 API 对比。 - 🔌 **MCP 服务** — `antd mcp` 启动 stdio 服务，原生集成 Claude Desktop、Cursor 等 IDE。 ## 📦 安装 ```bash npm install -g @ant-design/cli ``` 其他包管理器 ```bash pnpm add -g @ant-design/cli bun add -g @ant-design/cli ``` ## 🤖 Agent 集成 CLI 内置 [Skill 文件](https://npmcn.com/package/%40ant-design/cli/skills/antd/SKILL.md)，指导 Code Agent 在正确的时机调用正确的命令： ```bash npx skills add ant-design/ant-design-cli ``` 或者直接告诉你的 Code Agent： > 安装 `@ant-design/cli` 和 `ant-design/ant-design-cli` 的 antd skill Agent 会自动完成 `npm install`、`npx skills add`，并开始使用 CLI。 ### MCP 服务 支持 [Model Context Protocol](https://modelcontextprotocol.io/) 的 IDE 可直接将 CLI 作为 MCP 服务使用： ```json { "mcpServers": { "antd": { "command": "antd", "args": ["mcp"] } } } ``` 如需固定 antd 版本，在 `args` 数组中添加 `"--version", "5.20.0"`。 提供 8 个工具（`antd_list`、`antd_info`、`antd_doc`、`antd_demo`、`antd_token`、`antd_design_md`、`antd_semantic`、`antd_changelog`）和 2 个提示词（`antd-expert`、`antd-page-generator`）。 支持 [Claude Code](https://claude.ai/code)、[Cursor](https://cursor.sh/)、[Codex](https://openai.com/codex)、[Gemini CLI](https://github.com/google-gemini/gemini-cli) 等所有兼容 [skills](https://github.com/nicepkg/agent-skills) 协议的 Agent。 ## 🚀 快速开始 ```bash antd list # 所有组件及版本信息 antd info Button # 组件 Props、类型、默认值 antd doc Button # 完整 Markdown 文档 antd demo Select basic # 可运行的 Demo 源码 antd token DatePicker # Design Token 值（v5+） antd design.md # 设计语言文档（design.md） antd semantic Table # classNames / styles 结构 antd changelog 4.24.0 5.0.0 Select # 跨版本 API 差异对比 antd doctor # 诊断项目配置问题 antd env # 收集环境信息用于 Bug 报告 antd usage ./src # 分析项目中的 antd 导入 antd lint ./src # 检查废弃 API 和最佳实践 antd migrate 3 4 # v3 → v4 迁移指南 antd migrate 4 5 --apply ./src # 生成 Agent 迁移提示 antd mcp # 启动 MCP 服务，供 IDE 集成 antd setup --client claude # 为 AI Agent 接入 MCP/Skill antd upgrade # 升级 CLI 到最新版本 ``` ## 📖 命令 ### 📚 知识查询 | 命令 | 说明 | | --- | --- | | [`antd list`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-list) | 列出所有组件，含双语名称、分类和引入版本 | | [`antd info `](https://npmcn.com/package/%40ant-design/cli/#readme-antd-info-component) | Props 表格，含类型、默认值、引入版本和废弃状态 | | [`antd doc `](https://npmcn.com/package/%40ant-design/cli/#readme-antd-doc-component) | 组件完整 Markdown 文档 | | [`antd demo [name]`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-demo-component-name) | 可运行的 Demo 源码（TSX） | | [`antd token [Component]`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-token-component) | 全局或组件级 Design Token | | [`antd design.md`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-designmd) | 设计语言文档（`design.md`），供 AI 设计工具消费 | | [`antd semantic `](https://npmcn.com/package/%40ant-design/cli/#readme-antd-semantic-component) | 语义化 `classNames` / `styles` 结构及用法示例 | | [`antd changelog`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-changelog-v1-v2-component) | Changelog 条目、版本范围或跨版本 API 对比 | ### 🔍 项目分析 | 命令 | 说明 | | --- | --- | | [`antd doctor`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-doctor) | 10 项诊断检查：React 兼容性、重复安装、peer 依赖、SSR、babel 插件 | | [`antd env [dir]`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-env-dir) | 一键收集 antd 相关环境信息，用于 Bug 报告或 AI 辅助诊断 | | [`antd usage [dir]`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-usage-dir) | 导入统计、子组件分布（`Form.Item`）、非组件导出 | | [`antd lint [target]`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-lint-target) | 废弃 API、无障碍缺陷、性能问题、最佳实践 | | [`antd migrate `](https://npmcn.com/package/%40ant-design/cli/#readme-antd-migrate-from-to) | 迁移清单，区分自动修复/手动处理，`--apply` 生成 Agent 提示 | ### 🐛 问题反馈 | 命令 | 说明 | | --- | --- | | [`antd bug`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-bug) | 向 ant-design/ant-design 报告 Bug，自动收集环境信息 | | [`antd bug-cli`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-bug-cli) | 向 ant-design/ant-design-cli 报告 Bug | ### 🔧 CLI 管理 | 命令 | 说明 | | --- | --- | | [`antd mcp`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-mcp) | 启动 MCP stdio 服务，供 IDE Agent 集成 | | [`antd setup`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-setup) | 为 Claude Code、Cursor、VS Code 或 Codex 接入 Ant Design MCP/Skill | | [`antd upgrade`](https://npmcn.com/package/%40ant-design/cli/#readme-antd-upgrade) | 升级 CLI 到最新版本 | * * * ### `antd list` ```bash antd list # 所有组件 antd list --version 5.0.0 # v5.0.0 中可用的组件 ``` 示例输出 ``` Component 组件名 Description Since -------------- ------- ------------------------------------------------------- ------ Button 按钮 To trigger an operation. 4.0.0 Table 表格 A table displays rows of data. 4.0.0 Form 表单 High performance Form component with data scope management. 4.0.0 Select 选择器 Select component to select value from options. 4.0.0 Modal 对话框 Modal dialogs. 4.0.0 ColorPicker 颜色选择器 Used for color selection. 5.5.0 ... ``` ### `antd info ` ```bash antd info Button # Props 表格 antd info Button --detail # + 描述、引入版本、废弃状态、FAQ antd info Button --version 4.24.0 # v4 API 快照 ``` 示例输出 ``` Button (按钮) — To trigger an operation. Property Type Default Since --------------- -------------------------------------------- -------- ------ autoInsertSpace boolean true 5.17.0 block boolean false - classNames Record - 5.4.0 disabled boolean false - href string - - icon ReactNode - - loading boolean | { delay: number, icon: ReactNode } false - size large | middle | small middle - type primary | default | dashed | text | link default - variant outlined | dashed | solid | filled | text - 5.13.0 onClick (event: React.MouseEvent) => void - - ``` ### `antd doc ` ```bash antd doc Button # 完整 Markdown 文档输出到 stdout antd doc Button --format json # { name, doc } antd doc Button --lang zh # 中文文档 ``` ### `antd demo [name]` ```bash antd demo Button # 列出所有可用 Demo antd demo Button basic # 获取 Demo 源码 ``` ### `antd token [Component]` ```bash antd token # 全局 Token（colorPrimary、borderRadius 等） antd token Button # 组件级 Token ``` ### `antd design.md` 输出 antd **设计语言文档**（`design.md`）—— 对 antd 默认 Light 主题的精心编写的描述，遵循 [google-labs-code/design.md](https://github.com/google-labs-code/design.md) 规范。`antd token` 列举单个 Token 名称，而 `antd design.md` 整体描述设计语言（颜色 / 字体 / 间距 / 圆角的取值及其背后的设计原则），可被 AI 设计工具（Figma Make、Stitch 等）和 Agent 直接消费。 ```bash antd design.md # 输出当前检测版本的 design.md antd design.md --version 6.4.0 # 指定版本的 design.md antd design.md --format json # { doc } ``` `design.md` 按**大版本**区分（antd 只在大版本升级时重写它），因此按 major 解析。目前**仅 antd v6** 提供 `design.md` —— 查询没有该文档的大版本（v3/v4/v5）会返回 `UNSUPPORTED_VERSION_FEATURE`。它与发布在 [`https://ant.design/design.md`](https://ant.design/design.md) 的官方 `DESIGN.md` 保持一致。 ### `antd semantic ` ```bash antd semantic Table ``` 示例输出 ``` Table Semantic Structure: ├── header # 表头区域 ├── body # 表体区域 ├── footer # 表尾区域 ├── cell # 单元格 ├── row # 行 └── wrapper # 外层容器 Usage:
``` ### `antd changelog [v1] [v2] [component]` ```bash antd changelog 5.22.0 # 单个版本 antd changelog 5.21.0..5.24.0 # 版本范围（两端包含） antd changelog 4.24.0 5.0.0 # 两个版本间的 API 差异 antd changelog 4.24.0 5.0.0 Select # 仅对比 Select 的 API ``` * * * ### `antd doctor` 对项目执行 10 项检查：antd 是否安装、React 版本兼容性、antd/dayjs/cssinjs 重复安装、peer 依赖满足度、主题配置、babel-plugin-import 使用、CSS-in-JS 配置。 ```bash antd doctor antd doctor --format json ``` ### `antd env [dir]` 一键收集 antd 相关的所有环境信息 — 系统、Node、包管理器、浏览器、依赖包、生态包（`@ant-design/*`、`rc-*`）和构建工具。 ```bash antd env # 文本输出（粘贴到 GitHub Issue） antd env --format json # 结构化 JSON，供 AI 消费 antd env --format markdown # Markdown 表格输出 antd env ./my-project # 扫描指定项目目录 ``` 示例输出 ```text Environment System: OS macOS 15.3 Binaries: Node 20.11.0 pnpm 9.1.0 Registry https://registry.npmmirror.com/ Browsers: Chrome 131.0.6778.86 Safari 18.3 Dependencies: antd 5.22.0 react 18.3.1 react-dom 18.3.1 dayjs 1.11.13 @ant-design/cssinjs 1.22.1 @ant-design/icons 5.5.2 Ecosystem: @ant-design/pro-components 2.8.1 rc-field-form 2.7.0 Build Tools: umi 4.3.0 typescript 5.6.3 less 4.2.0 ``` ### `antd usage [dir]` ```bash antd usage # 扫描当前目录 antd usage ./src # 扫描指定目录 antd usage -f Button # 过滤特定组件 ``` ### `antd lint [target]` 四类规则：`deprecated`（废弃 API）、`a11y`（无障碍）、`performance`（性能）、`best-practice`（最佳实践）。废弃规则从元数据动态生成，始终与检测到的 antd 版本保持同步。 ```bash antd lint ./src antd lint ./src --only deprecated antd lint ./src --only a11y antd lint ./src --only deprecated --format json --antd-alias @shared-components ``` 使用 `--antd-alias ` 可以把额外包名视为 `antd` 的别名；可重复传入多个包装包名，且默认仍会匹配 `antd`。 ### `antd migrate ` v3→v4 包含 15+ 迁移步骤，v4→v5 包含 25+ 迁移步骤，v5→v6 包含 30+。每个步骤包含组件名、破坏性标记、搜索正则和前后代码对比。 ```bash antd migrate 3 4 # v3 → v4 迁移 antd migrate 4 5 # 完整迁移清单 antd migrate 4 5 --component Select # 指定组件 antd migrate 4 5 --apply ./src # 生成 Agent 迁移提示 ``` 示例输出 ``` Migration Guide: v4 → v5 Select: 🔧 [BREAKING] Prop `dropdownClassName` renamed to `popupClassName` 🔧 [BREAKING] Prop `dropdownMatchSelectWidth` renamed to `popupMatchSelectWidth` Total: 2 steps (2 auto-fixable, 0 manual) ``` ### `antd bug` ```bash antd bug --title "DatePicker 选择日期时崩溃" antd bug --title "..." --steps "1. 点击" --expected "正常" --actual "崩溃" antd bug --title "..." --submit # 通过 gh CLI 提交 ``` ### `antd bug-cli` ```bash antd bug-cli --title "info 命令在 v4 组件上崩溃" antd bug-cli --title "..." --submit ``` ### `antd mcp` 启动 MCP（Model Context Protocol）stdio 服务，供 IDE Agent 集成。提供 8 个工具和 2 个提示词，支持 Claude Desktop、Cursor 等 IDE 原生集成。 ```bash antd mcp # 使用自动检测的版本启动 antd mcp --version 5.20.0 --lang zh # 指定版本和语言 ``` IDE 配置（`claude_desktop_config.json`）： ```json { "mcpServers": { "antd": { "command": "antd", "args": ["mcp"] } } } ``` **MCP 工具（8 个）：** `antd_list`、`antd_info`、`antd_doc`、`antd_demo`、`antd_token`、`antd_design_md`、`antd_semantic`、`antd_changelog` **MCP 提示词（2 个）：** `antd-expert`、`antd-page-generator` ### `antd setup` 为本地 AI Agent 项目接入 Ant Design MCP 和/或内置的 `skills/antd` 指南。该命令可以写入对应客户端的 MCP 配置、安装适配客户端的技能或技能参考，并为 Agent 写入托管指令。 ```bash antd setup --client claude # 写入 .mcp.json antd setup --client cursor # 写入 .cursor/mcp.json antd setup --client vscode # 写入 .vscode/mcp.json antd setup --client codex # 安装 Codex 项目技能 antd setup --client claude --dry-run # 预览配置，不写入文件 antd setup --client claude --project ./my-app antd setup --client claude --version 5.29.3 --lang zh antd setup --client claude --check # 校验已有配置 antd setup --client claude --mode skill # 安装 Claude 技能并写入指令 antd setup --client claude --mode both # 写入 MCP 配置、安装技能并写入指令 antd setup --client claude --write-instructions ``` 模式： | 模式 | 行为 | | --- | --- | | `mcp` | 只写入客户端 MCP 配置。这是默认模式。 | | `skill` | 为所选客户端安装内置 Ant Design 指南，并写入托管指令。 | | `both` | 写入 MCP 配置、安装技能或技能参考，并写入托管指令。 | 支持的客户端： | 客户端 | 配置文件 | 服务字段 | 技能位置 | 指令文件 | | --- | --- | --- | --- | --- | | `claude` | `.mcp.json` | `mcpServers` | `.claude/skills/antd/` | `CLAUDE.md` | | `cursor` | `.cursor/mcp.json` | `mcpServers` | `.agents/skills/antd/` 共享技能 | `AGENTS.md` | | `vscode` | `.vscode/mcp.json` | `servers` | `.agents/skills/antd/` 共享技能 | `AGENTS.md` | | `codex` | \- | \- | `.agents/skills/antd/` 共享技能 | `AGENTS.md` | 生成的服务项： ```json { "mcpServers": { "antd": { "command": "npx", "args": ["-y", "@ant-design/cli", "mcp", "--version", "5.29.3", "--lang", "zh"] } } } ``` 技能指令会写入所选客户端对应的指令文件：Claude 使用 `CLAUDE.md`，Cursor、VS Code 和 Codex 使用 `AGENTS.md`。Claude 会获得 `.claude/skills/antd/` 下的项目级原生技能；Cursor、VS Code 和 Codex 会获得同一份 `.agents/skills/antd/` 共享技能，并通过指令区块告诉 Agent 何时使用。 Codex setup 目前只支持技能安装。请使用 `antd setup --client codex --mode skill`，也可以省略 `--mode`，因为 Codex 默认使用 `skill` 模式。 使用 `--check` 可以只校验已有配置，不写入文件。当所选模式已正确配置时退出码为 `0`，配置、技能文件或指令缺失/不一致时退出码为 `1`。 在默认 `mcp` 模式下使用 `--write-instructions`，可以额外向选中的 Agent 指令文件写入一个可重复更新的托管区块，提示 Agent 在生成 Ant Design 代码前优先使用已配置的 `antd` MCP 服务。与 `--check` 一起使用时，也会校验该指令区块。 ### `antd upgrade` 升级 CLI 自身到 npm 上发布的最新版本。自动检测安装 CLI 的包管理器（npm、yarn、pnpm、bun、cnpm、utoo）并执行对应的升级命令。 ```bash antd upgrade # 升级到最新版本 ``` 示例输出 ```text 正在升级 @ant-design/cli: v6.4.3 → v6.4.4 执行: npm install -g @ant-design/cli@latest ... (包管理器输出透传) ... 成功升级到 v6.4.4 ``` ## ⚙️ 全局参数 | 参数 | 说明 | 默认值 | | --- | --- | --- | | `--format json|text|markdown` | 输出格式 | `text` | | `--version ` | 目标 antd 版本（如 `5.20.0`） | 自动检测 | | `--lang en|zh` | 输出语言 | `en` | | `--detail` | 包含扩展信息 | `false` | | `-V, --cli-version` | 打印 CLI 版本号 | — | **版本自动检测**：`--version` 参数 → `node_modules/antd` → `package.json` 依赖声明 → 回退 `5.24.0` ### 环境变量 | 变量 | 说明 | | --- | --- | | `ANTD_NO_AUTO_REPORT=1` | 禁用 AI Agent 的 Bug 上报建议（详见 [#82](https://github.com/ant-design/ant-design-cli/issues/82)） | | `NO_UPDATE_CHECK=1` | 跳过静默版本更新检查 | | `CI=1` | 跳过静默版本更新检查（同 `NO_UPDATE_CHECK=1`） | ## 📄 开源协议 [MIT](https://npmcn.com/package/%40ant-design/cli/LICENSE) © [Ant Design](https://ant.design/) ## 常见问题 ### @ant-design/cli 是什么？ 用于查询蚂蚁知识和分析蚂蚁在项目中的使用情况的CLI工具 ### 如何安装 @ant-design/cli？ 在项目目录运行 npm install @ant-design/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 antd，可以用 npx antd 直接运行。 ### @ant-design/cli 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @ant-design/cli 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @ant-design/cli 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @ant-design/cli 可以商用吗？ @ant-design/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @ant-design/cli 的下载量有多少？ 根据 npm 官方下载统计，@ant-design/cli 在 2026/10/06 – 2026/11/04 这 30 天内被下载 75,037 次，日均约 2,501 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @ant-design/cli 还在维护吗？ 最新版本 6\.7\.0 发布于 2026/11/04（2 天前）；至今共发布 30 个版本，其中过去 12 个月发布了 30 个；首次发布于 2026/03/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。