@ant-design/cli 6.4.3 → 6.4.5

package/README.md

@@ -4,7 +4,7 @@
 
 <img src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" alt="Ant Design" width="72">
 
-<h1>@ant-design/cli</h1>
+<h1>Ant Design CLI</h1>
 
 **Ant Design on your command line.**<br>
 Query component knowledge, analyze project usage, and guide migrations — fully offline.
@@ -41,8 +41,8 @@ npx skills add ant-design/ant-design-cli    # install as an agent skill
 - 🤖 **Agent-optimized** — `--format json` on every command. Structured errors with codes and suggestions. Clean stdout/stderr separation.
 - 🌍 **Bilingual** — Every component name, description, and doc has both English and Chinese. Switch with `--lang zh`.
 - 🔮 **Smart matching** — Typo `Buttn`? The CLI suggests `Button` using Levenshtein distance, with first-letter preference.
-- 🧩 **15 commands** — From prop lookup to project-wide lint, from design token queries to cross-version API diffing.
-- 🔌 **MCP server** — `antd mcp` starts a stdio server for native IDE integration (Claude Desktop, Cursor).
+- 🧩 **18 commands** — From prop lookup to project-wide lint, from design token queries to cross-version API diffing.
+- 🔌 **MCP server** — `antd mcp` starts a stdio server for native IDE integration (Claude Code, Cursor, VS Code, etc.).
 
 <br>
 
@@ -84,6 +84,19 @@ Works with [Claude Code](https://claude.ai/code), [Cursor](https://cursor.sh), [
 
 For IDEs that support [Model Context Protocol](https://modelcontextprotocol.io), the CLI can run as an MCP server:
 
+```json
+{
+  "mcpServers": {
+    "antd": {
+      "command": "npx",
+      "args": ["-y", "@ant-design/cli", "mcp"]
+    }
+  }
+}
+```
+
+Or if you have the CLI installed globally (`npm i -g @ant-design/cli`):
+
 ```json
 {
   "mcpServers": {
@@ -97,7 +110,7 @@ For IDEs that support [Model Context Protocol](https://modelcontextprotocol.io),
 
 To pin a specific antd version, add `"--version", "5.20.0"` to the `args` array.
 
-This exposes 7 tools (`antd_list`, `antd_info`, `antd_doc`, `antd_demo`, `antd_token`, `antd_semantic`, `antd_changelog`) and 2 prompts (`antd-expert`, `antd-page-generator`) for native IDE integration.
+This exposes 8 tools (`antd_list`, `antd_info`, `antd_doc`, `antd_demo`, `antd_token`, `antd_design_md`, `antd_semantic`, `antd_changelog`) and 2 prompts (`antd-expert`, `antd-page-generator`) for native IDE integration.
 
 <br>
 
@@ -109,6 +122,7 @@ antd info Button                    # Component props, types, defaults
 antd doc Button                     # Full markdown documentation
 antd demo Select basic              # Runnable demo source code
 antd token DatePicker               # Design Token values (v5+)
+antd design.md                      # Design-language document (design.md)
 antd semantic Table                 # classNames / styles structure
 antd changelog 4.24.0 5.0.0 Select  # API diff across versions
 antd doctor                         # Diagnose project issues
@@ -117,6 +131,9 @@ antd usage ./src                    # Analyze antd imports in project
 antd lint ./src                     # Check deprecated APIs & best practices
 antd migrate 3 4                    # v3 → v4 migration guide
 antd migrate 4 5 --apply ./src      # Agent-ready migration prompt
+antd mcp                            # Start MCP server for IDE integration
+antd setup --client claude          # Set up MCP/Skill for AI agents
+antd upgrade                        # Upgrade CLI to latest version
 ```
 
 <br>
@@ -132,6 +149,7 @@ antd migrate 4 5 --apply ./src      # Agent-ready migration prompt
 | [`antd doc <Component>`](#antd-doc-component) | Full markdown documentation for a component |
 | [`antd demo <Component> [name]`](#antd-demo-component-name) | Runnable demo source code (TSX) |
 | [`antd token [Component]`](#antd-token-component) | Global or component-level Design Tokens |
+| [`antd design.md`](#antd-designmd) | Design-language document (`design.md`) for AI design tools |
 | [`antd semantic <Component>`](#antd-semantic-component) | Semantic `classNames` / `styles` structure with usage examples |
 | [`antd changelog`](#antd-changelog-v1-v2-component) | Changelog entries, version ranges, or cross-version API diff |
 
@@ -152,6 +170,14 @@ antd migrate 4 5 --apply ./src      # Agent-ready migration prompt
 | [`antd bug`](#antd-bug) | File a bug to ant-design/ant-design with auto-collected environment info |
 | [`antd bug-cli`](#antd-bug-cli) | File a bug to ant-design/ant-design-cli |
 
+### 🔧 CLI Management
+
+| Command | Description |
+|---|---|
+| [`antd mcp`](#antd-mcp) | Start MCP stdio server for IDE agent integration |
+| [`antd setup`](#antd-setup) | Write local MCP config or install skills for Claude Code, Cursor, VS Code, or Codex |
+| [`antd upgrade`](#antd-upgrade) | Upgrade the CLI to the latest version |
+
 <br>
 
 ---
@@ -233,6 +259,18 @@ antd token                          # global tokens (colorPrimary, borderRadius,
 antd token Button                   # component-level tokens
 ```
 
+### `antd design.md`
+
+Output the antd **design-language document** (`design.md`) — a curated description of antd's default light theme, conformant with the [google-labs-code/design.md](https://github.com/google-labs-code/design.md) spec. Where `antd token` lists individual token names, `antd design.md` describes the design language as a whole (color/typography/spacing/radius values plus the principles behind them), so AI design tools (Figma Make, Stitch, etc.) and agents can consume antd's design language directly.
+
+```bash
+antd design.md                      # design.md for the detected version
+antd design.md --version 6.4.0      # design.md for a specific version
+antd design.md --format json        # { doc }
+```
+
+`design.md` is **major-grained** (antd rewrites it only across major releases), so it is resolved by major version. A `design.md` is currently published only for **antd v6** — requesting a major without one (v3/v4/v5) returns `UNSUPPORTED_VERSION_FEATURE`. It mirrors the canonical `DESIGN.md` published at [`https://ant.design/design.md`](https://ant.design/design.md).
+
 ### `antd semantic <Component>`
 
 ```bash
@@ -271,7 +309,7 @@ antd changelog 4.24.0 5.0.0 Select  # API diff for Select only
 
 ### `antd doctor`
 
-Runs 10 checks against your project: antd installed, React version compat, duplicate antd/dayjs/cssinjs installs, peer dependency satisfaction, theme config, babel-plugin-import usage, and CSS-in-JS setup.
+Runs 10 checks against your project: antd installed and bundled known-bug version data, React version compat, duplicate antd/dayjs/cssinjs installs, peer dependency satisfaction, theme config, babel-plugin-import usage, and CSS-in-JS setup. All checks use bundled/local data and do not make network calls.
 
 ```bash
 antd doctor
@@ -389,6 +427,108 @@ antd bug-cli --title "info command crashes on v4"
 antd bug-cli --title "..." --submit
 ```
 
+### `antd mcp`
+
+Start an MCP (Model Context Protocol) stdio server for IDE agent integration. Exposes 8 tools and 2 prompts for native IDE integration (Claude Code, Cursor, VS Code, Codex, etc.).
+
+```bash
+antd mcp                                # start with auto-detected version
+antd mcp --version 5.20.0 --lang zh     # pin version and language
+```
+
+Configuration:
+
+```json
+{
+  "mcpServers": {
+    "antd": {
+      "command": "npx",
+      "args": ["-y", "@ant-design/cli", "mcp"]
+    }
+  }
+}
+```
+
+**MCP Tools (8):** `antd_list`, `antd_info`, `antd_doc`, `antd_demo`, `antd_token`, `antd_design_md`, `antd_semantic`, `antd_changelog`
+
+**MCP Prompts (2):** `antd-expert`, `antd-page-generator`
+
+### `antd setup`
+
+Configure a local AI agent project with Ant Design MCP and/or the bundled `skills/antd` guidance. The command can write the client-specific MCP config file, install a client-appropriate skill or skill reference, and add managed instructions for agents.
+
+```bash
+antd setup --client claude              # write .mcp.json
+antd setup --client cursor              # write .cursor/mcp.json
+antd setup --client vscode              # write .vscode/mcp.json
+antd setup --client codex               # install Codex project skill
+antd setup --client claude --dry-run    # preview without writing files
+antd setup --client claude --project ./my-app
+antd setup --client claude --version 5.29.3 --lang zh
+antd setup --client claude --check      # verify existing config
+antd setup --client claude --mode skill # install Claude skill and write instructions
+antd setup --client claude --mode both  # write MCP config, install skill, and write instructions
+antd setup --client claude --write-instructions
+```
+
+Modes:
+
+| Mode | Behavior |
+|---|---|
+| `mcp` | Writes the client MCP config only. This is the default. |
+| `skill` | Installs the bundled Ant Design guidance for the selected client and writes a managed instruction block. |
+| `both` | Writes MCP config, installs the skill or skill reference, and writes the managed instruction block. |
+
+Supported clients:
+
+| Client | Config file | Server key | Skill target | Instructions file |
+|---|---|---|---|---|
+| `claude` | `.mcp.json` | `mcpServers` | `.claude/skills/antd/` | `CLAUDE.md` |
+| `cursor` | `.cursor/mcp.json` | `mcpServers` | `.agents/skills/antd/` shared skill | `AGENTS.md` |
+| `vscode` | `.vscode/mcp.json` | `servers` | `.agents/skills/antd/` shared skill | `AGENTS.md` |
+| `codex` | - | - | `.agents/skills/antd/` shared skill | `AGENTS.md` |
+
+Generated server entry:
+
+```json
+{
+  "mcpServers": {
+    "antd": {
+      "command": "npx",
+      "args": ["-y", "@ant-design/cli", "mcp", "--version", "5.29.3", "--lang", "zh"]
+    }
+  }
+}
+```
+
+Skill instructions are written to the selected client's instruction file: Claude uses `CLAUDE.md`; Cursor, VS Code, and Codex use `AGENTS.md`. Claude gets a native project skill under `.claude/skills/antd/`; Cursor, VS Code, and Codex get the same bundled guidance under `.agents/skills/antd/` and an instruction block telling agents when to use it.
+
+Codex setup currently supports skill installation only. Use `antd setup --client codex --mode skill`, or omit `--mode` because Codex defaults to `skill`.
+
+Use `--check` to validate an existing setup without writing files. It exits with code `0` when the selected mode is configured, and `1` when config, skill files, or instructions are missing or different.
+
+Use `--write-instructions` with the default `mcp` mode to also add an idempotent managed block to the selected agent instructions file, telling agents to use the configured `antd` MCP server before generating Ant Design code. With `--check`, it also verifies that instruction block.
+
+### `antd upgrade`
+
+Upgrade the CLI itself to the latest version published on npm. Automatically detects which package manager installed the CLI (npm, yarn, pnpm, bun, cnpm, utoo) and runs the corresponding upgrade command.
+
+```bash
+antd upgrade                        # upgrade to latest version
+```
+
+<details>
+<summary>Example output</summary>
+
+```text
+Upgrading @ant-design/cli: v6.4.3 → v6.4.4
+Running: npm install -g @ant-design/cli@latest
+... (passthrough package manager output) ...
+Successfully upgraded to v6.4.4
+```
+
+</details>
+
 <br>
 
 ## ⚙️ Global Flags

package/README.zh-CN.md

@@ -4,7 +4,7 @@
 
 <img src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" alt="Ant Design" width="72">
 
-<h1>@ant-design/cli</h1>
+<h1>Ant Design CLI</h1>
 
 **命令行上的 Ant Design。**<br>
 查询组件知识、分析项目用量、指导版本迁移 — 完全离线。
@@ -41,7 +41,7 @@ npx skills add ant-design/ant-design-cli    # 安装为 Agent Skill
 - 🤖 **Agent 优化** — 所有命令支持 `--format json`。结构化错误码与修复建议。stdout/stderr 严格分离。
 - 🌍 **双语输出** — 每个组件名、描述和文档均有中英文。通过 `--lang zh` 切换。
 - 🔮 **智能纠错** — 输入 `Buttn`？CLI 基于 Levenshtein 距离建议 `Button`，优先匹配首字母相同的候选。
-- 🧩 **15 条命令** — 从 Prop 查询到项目级 Lint，从 Design Token 到跨版本 API 对比。
+- 🧩 **18 条命令** — 从 Prop 查询到项目级 Lint，从 Design Token 到跨版本 API 对比。
 - 🔌 **MCP 服务** — `antd mcp` 启动 stdio 服务，原生集成 Claude Desktop、Cursor 等 IDE。
 
 <br>
@@ -95,7 +95,7 @@ Agent 会自动完成 `npm install`、`npx skills add`，并开始使用 CLI。
 
 如需固定 antd 版本，在 `args` 数组中添加 `"--version", "5.20.0"`。
 
-提供 7 个工具（`antd_list`、`antd_info`、`antd_doc`、`antd_demo`、`antd_token`、`antd_semantic`、`antd_changelog`）和 2 个提示词（`antd-expert`、`antd-page-generator`）。
+提供 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。
 
@@ -109,6 +109,7 @@ 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                         # 诊断项目配置问题
@@ -117,6 +118,9 @@ 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 到最新版本
 ```
 
 <br>
@@ -132,6 +136,7 @@ antd migrate 4 5 --apply ./src      # 生成 Agent 迁移提示
 | [`antd doc <Component>`](#antd-doc-component) | 组件完整 Markdown 文档 |
 | [`antd demo <Component> [name]`](#antd-demo-component-name) | 可运行的 Demo 源码（TSX） |
 | [`antd token [Component]`](#antd-token-component) | 全局或组件级 Design Token |
+| [`antd design.md`](#antd-designmd) | 设计语言文档（`design.md`），供 AI 设计工具消费 |
 | [`antd semantic <Component>`](#antd-semantic-component) | 语义化 `classNames` / `styles` 结构及用法示例 |
 | [`antd changelog`](#antd-changelog-v1-v2-component) | Changelog 条目、版本范围或跨版本 API 对比 |
 
@@ -152,6 +157,14 @@ antd migrate 4 5 --apply ./src      # 生成 Agent 迁移提示
 | [`antd bug`](#antd-bug) | 向 ant-design/ant-design 报告 Bug，自动收集环境信息 |
 | [`antd bug-cli`](#antd-bug-cli) | 向 ant-design/ant-design-cli 报告 Bug |
 
+### 🔧 CLI 管理
+
+| 命令 | 说明 |
+|---|---|
+| [`antd mcp`](#antd-mcp) | 启动 MCP stdio 服务，供 IDE Agent 集成 |
+| [`antd setup`](#antd-setup) | 为 Claude Code、Cursor、VS Code 或 Codex 接入 Ant Design MCP/Skill |
+| [`antd upgrade`](#antd-upgrade) | 升级 CLI 到最新版本 |
+
 <br>
 
 ---
@@ -233,6 +246,18 @@ 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 <Component>`
 
 ```bash
@@ -389,6 +414,108 @@ 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                        # 升级到最新版本
+```
+
+<details>
+<summary>示例输出</summary>
+
+```text
+正在升级 @ant-design/cli: v6.4.3 → v6.4.4
+执行: npm install -g @ant-design/cli@latest
+... (包管理器输出透传) ...
+成功升级到 v6.4.4
+```
+
+</details>
+
 <br>
 
 ## ⚙️ 全局参数