ant-design-cli

Ant Design on your command line. Query component knowledge, analyze project usage, and guide migrations — fully offline.

English · 中文 · Changelog

🤔 Why

Code agents (Claude Code, Codex, Gemini CLI) write better antd code when they have instant access to the right API data. This CLI gives them exactly that — every prop, token, demo, and changelog entry for antd v3 / v4 / v5 / v6, bundled locally, queryable in milliseconds.

npx skills add ant-design/ant-design-cli    # install as an agent skill

✨ Highlights

• 📦 Fully offline — All metadata ships with the package. No network calls, no latency, no API keys.
• 🎯 Version-accurate — 55+ per-minor snapshots across v3/v4/v5/v6. Query the exact API surface of antd@5.3.0, not just "latest v5".
• 🤖 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.
• 🧩 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.).

📦 Install

npm install -g @ant-design/cli

pnpm add -g @ant-design/cli
bun add -g @ant-design/cli

🤖 Agent Integration

The CLI ships with a skill file that teaches code agents when and how to use each command:

npx skills add ant-design/ant-design-cli

Or simply tell your code agent:

Install @ant-design/cli and the antd skill from ant-design/ant-design-cli

The agent will handle npm install, npx skills add, and start using the CLI automatically.

Works with Claude Code, Cursor, Codex, Gemini CLI, and any agent supporting the skills protocol.

MCP Server

For IDEs that support Model Context Protocol, the CLI can run as an MCP server:

{
  "mcpServers": {
    "antd": {
      "command": "npx",
      "args": ["-y", "@ant-design/cli", "mcp"]
    }
  }
}

Or if you have the CLI installed globally (npm i -g @ant-design/cli):

{
  "mcpServers": {
    "antd": {
      "command": "antd",
      "args": ["mcp"]
    }
  }
}

To pin a specific antd version, add "--version", "5.20.0" to the args array.

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.

🚀 Quick Start

antd list                           # All components with versions
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
antd env                            # Collect env info for bug reports
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

📖 Commands

📚 Knowledge Query

Command	Description
antd list	List all components with bilingual names, categories, and since versions
antd info <Component>	Props table with types, defaults, since, and deprecated status
antd doc <Component>	Full markdown documentation for a component
antd demo <Component> [name]	Runnable demo source code (TSX)
antd token [Component]	Global or component-level Design Tokens
antd design.md	Design-language document (design.md) for AI design tools
antd semantic <Component>	Semantic classNames / styles structure with usage examples
antd changelog	Changelog entries, version ranges, or cross-version API diff

🔍 Project Analysis

Command	Description
antd doctor	10 diagnostic checks: React compat, duplicates, peer deps, SSR, babel plugins
antd env [dir]	Collect all antd-related environment info for bug reporting or AI diagnosis
antd usage [dir]	Import stats, sub-component breakdown (Form.Item), non-component exports
antd lint [target]	Deprecated APIs, accessibility gaps, performance issues, best practices
antd migrate <from> <to>	Migration checklist with auto-fixable/manual split and --apply agent prompt

🐛 Issue Reporting

Command	Description
antd bug	File a bug to ant-design/ant-design with auto-collected environment info
antd bug-cli	File a bug to ant-design/ant-design-cli

🔧 CLI Management

Command	Description
antd mcp	Start MCP stdio server for IDE agent integration
antd setup	Write local MCP config or install skills for Claude Code, Cursor, VS Code, or Codex
antd upgrade	Upgrade the CLI to the latest version

---

antd list

antd list                           # all components
antd list --version 5.0.0           # components available in 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 <Component>

antd info Button                    # props table
antd info Button --detail           # + descriptions, since, deprecated, FAQ
antd info Button --version 4.24.0   # v4 API snapshot

Button (按钮) — To trigger an operation.

Property         Type                                          Default   Since
---------------  --------------------------------------------  --------  ------
autoInsertSpace  boolean                                       true      5.17.0
block            boolean                                       false     -
classNames       Record<SemanticDOM, string>                   -         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 <Component>

antd doc Button                     # full markdown docs to stdout
antd doc Button --format json       # { name, doc }
antd doc Button --lang zh           # Chinese documentation

antd demo <Component> [name]

antd demo Button                    # list all available demos
antd demo Button basic              # get demo source code

antd token [Component]

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 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.

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.

antd semantic <Component>

antd semantic Table

Table Semantic Structure:
├── header    # Table header area
├── body      # Table body area
├── footer    # Table footer area
├── cell      # Table cell
├── row       # Table row
└── wrapper   # Outer wrapper

Usage:
  <Table classNames={{ header: 'my-header' }} />
  <Table styles={{ header: { background: '#fff' } }} />

antd changelog [v1] [v2] [component]