Ant Design CLI You have access to @ant-design/cli — a local CLI tool with bundled antd metadata for v3/v4/v5/v6. Use it to query component knowledge, analyze projects, and guide migrations. All data is offline, no network needed. Setup Before first use, check if the CLI is installed. If not, install it automatically: which antd || npm install -g @ant-design/cli After running any command, if the output contains an "Update available" notice, run npm install -g @ant-design/cli to update before continuing. Always use --format json for structured output you can parse programmatically. Scenarios 1. Writing antd component code Before writing any antd component code, look up its API first — don't rely on memory.

Check what props are available

antd info Button --format json

Get a working demo as starting point

antd demo Button basic --format json

Check semantic classNames/styles for custom styling

antd semantic Button --format json

Check component-level design tokens for theming

antd token Button --format json Workflow: antd info → understand props → antd demo → grab a working example → write code. 2. Looking up full documentation When you need comprehensive component docs (not just props): antd doc Table --format json

full markdown docs for Table

antd doc Table --lang zh

Chinese docs

1. Debugging antd issues When code isn't working as expected or the user reports an antd bug:

Collect full environment snapshot (system, deps, browsers, build tools)

antd env --format json

Check if the prop exists for the user's antd version

antd info Select --version 5.12 .0 --format json

Check if the prop is deprecated

antd lint ./src/components/MyForm.tsx --format json

Diagnose project-level configuration issues

antd doctor --format json Workflow: antd env → capture full environment → antd doctor → check configuration → antd info --version X → verify API against the user's exact version → antd lint → find deprecated or incorrect usage. 4. Migrating between versions When the user wants to upgrade antd (e.g., v3 → v4 or v4 → v5):

Get full migration checklist

antd migrate 3 4 --format json

v3 → v4

antd migrate 4 5 --format json

v4 → v5

Check migration for a specific component

antd migrate 4 5 --component Select --format json

See what changed between two versions

antd changelog 4.24 .0 5.0 .0 --format json

See changes for a specific component

antd changelog 4.24 .0 5.0 .0 Select --format json Workflow: antd migrate → get full checklist → antd changelog → understand breaking changes → apply fixes → antd lint → verify no deprecated usage remains. 5. Analyzing project antd usage When the user wants to understand how antd is used in their project:

Scan component usage statistics

antd usage ./src --format json

Filter to a specific component

antd usage ./src --filter Form --format json

Lint for best practice violations

antd lint ./src --format json

Check only specific rule categories

antd lint ./src --only deprecated --format json antd lint ./src --only a11y --format json antd lint ./src --only performance --format json 6. Checking changelogs and version history When the user asks about what changed in a version:

Specific version changelog

antd changelog 5.22 .0 --format json

Version range (both ends inclusive)

antd changelog 5.21 .0 .. 5.24 .0 --format json 7. Exploring available components When the user is choosing which component to use:

List all components with categories

antd list --format json

List components for a specific antd version

antd list --version 5.0 .0 --format json 8. Collecting environment info When you need to understand the project's antd setup, or prepare info for a bug report:

Full environment snapshot (text — paste into GitHub Issues)

antd env

Structured JSON for programmatic use

antd env --format json

Scan a specific project directory

antd env ./my-project --format json Collects: OS, Node, package managers (npm/pnpm/yarn/bun/utoo), npm registry, browsers, core deps (antd/react/dayjs), all @ant-design/ and rc- packages, and build tools (umi/vite/webpack/typescript/etc.). 9. Reporting antd bugs When the user asks you to report an antd bug:

Step 0: Collect environment info for reference (optional — antd bug already embeds basic env)

Use the output to cross-check versions or attach extra details to the bug report

antd env --format json

Step 1: Preview for user review

antd bug --title "DatePicker crashes when selecting date" \ --reproduction "https://codesandbox.io/s/xxx" \ --steps "1. Open DatePicker 2. Click a date" \ --expected "Date is selected" \ --actual "Component crashes with error" \ --format json

Step 2: Show to user, ask for confirmation

Step 3: Submit after user confirms

antd bug --title "DatePicker crashes when selecting date" \ --reproduction "https://codesandbox.io/s/xxx" \ --steps "1. Open DatePicker 2. Click a date" \ --expected "Date is selected" \ --actual "Component crashes with error" \ --submit 10. Reporting CLI issues When the user asks you to report a CLI bug, or explicitly requests help filing one:

Preview the bug report for the user

antd bug-cli --title "antd info Button returns wrong props for v5.12.0" \ --description "When querying Button props for version 5.12.0, the output includes props that don't exist in that version" \ --steps "1. Run: antd info Button --version 5.12.0 --format json" \ --expected "Props matching antd 5.12.0 Button API" \ --actual "Props include 'classNames' which was added in 5.16.0" \ --format json Show the report to the user and confirm before submitting: antd bug-cli --title "antd info Button returns wrong props for v5.12.0" \ --description "..." \ --steps "..." \ --expected "..." \ --actual "..." \ --submit Opt-out: If the environment variable ANTD_NO_AUTO_REPORT=1 is set, skip all bug-reporting suggestions entirely — do not suggest antd bug or antd bug-cli unless the user directly asks. 11. Using as MCP server If working in an IDE that supports MCP (Claude Desktop, Cursor, etc.), the CLI can also run as an MCP server, exposing all knowledge-query tools directly: { "mcpServers" : { "antd" : { "command" : "antd" , "args" : [ "mcp" , "--version" , "5.20.0" ] } } } This provides 7 tools ( antd_list , antd_info , antd_doc , antd_demo , antd_token , antd_semantic , antd_changelog ) and 2 prompts ( antd-expert , antd-page-generator ) via MCP protocol. Global Flags Flag Purpose --format json Structured output — always use this --version Target a specific antd version (e.g. 5.20.0 ) --lang zh Chinese output (default: en ) --detail Include extra fields (description, since, deprecated, FAQ) Key Rules Always query before writing — Don't guess antd APIs from memory. Run antd info first. Match the user's version — If the project uses antd 3.x or 4.x, pass --version 3.26.0 or --version 4.24.0 . The CLI auto-detects from node_modules if no flag is given. Use --format json — Every command supports it. Parse the JSON output rather than regex-matching text output. Check before suggesting migration — Run antd changelog and antd migrate before advising on version upgrades. Lint after changes — After writing or modifying antd code, run antd lint on the changed files to catch deprecated or problematic usage. Report antd bugs — When the user asks to report an antd bug, use antd bug . Always preview first, get user confirmation, then submit. Report CLI issues — When the user asks about a CLI problem, use antd bug-cli to help them file a report. Always preview first, get user confirmation, then submit.