Use when the user's task involves Ant Design (antd) — writing antd components, debugging antd issues, querying antd APIs/props/tokens/demos, migrating between antd versions, or analyzing antd usage in a project. Triggers on antd-related code, imports from 'antd', or explicit antd questions.
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.
The CLI is installed as a dev dependency. Use npx antd to run it.
Always use --format json for structured output you can parse programmatically.
Before writing any antd component code, look up its API first — don't rely on memory.
# Check what props are available
npx antd info Button --format json
# Get a working demo as starting point
npx antd demo Button basic --format json
# Check semantic classNames/styles for custom styling
npx antd semantic Button --format json
# Check component-level design tokens for theming
npx antd token Button --format jsonWorkflow: antd info → understand props → antd demo → grab a working example → write code.
When you need comprehensive component docs (not just props):
npx antd doc Table --format json # full markdown docs for Table
npx antd doc Table --lang zh # Chinese docsWhen code isn't working as expected or the user reports an antd bug:
# Collect full environment snapshot (system, deps, browsers, build tools)
npx antd env --format json
# Check if the prop exists for the user's antd version
npx antd info Select --version 5.12.0 --format json
# Check if the prop is deprecated
npx antd lint ./src/components/MyForm.tsx --format json
# Diagnose project-level configuration issues
npx antd doctor --format jsonWorkflow: 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.
When the user wants to upgrade antd (e.g., v3 → v4 or v4 → v5):
# Get full migration checklist
npx antd migrate 3 4 --format json # v3 → v4
npx antd migrate 4 5 --format json # v4 → v5
# Check migration for a specific component
npx antd migrate 4 5 --component Select --format json
# See what changed between two versions
npx antd changelog 4.24.0 5.0.0 --format json
# See changes for a specific component
npx antd changelog 4.24.0 5.0.0 Select --format jsonWorkflow: antd migrate → get full checklist → antd changelog <v1> <v2> → understand breaking changes → apply fixes → antd lint → verify no deprecated usage remains.
When the user wants to understand how antd is used in their project:
# Scan component usage statistics
npx antd usage ./src --format json
# Filter to a specific component
npx antd usage ./src --filter Form --format json
# Lint for best practice violations
npx antd lint ./src --format json
# Check only specific rule categories
npx antd lint ./src --only deprecated --format json
npx antd lint ./src --only a11y --format json
npx antd lint ./src --only performance --format jsonWhen the user asks about what changed in a version:
# Specific version changelog
npx antd changelog 5.22.0 --format json
# Version range (both ends inclusive)
npx antd changelog 5.21.0..5.24.0 --format jsonWhen the user is choosing which component to use:
# List all components with categories
npx antd list --format json
# List components for a specific antd version
npx antd list --version 5.0.0 --format jsonWhen you need to understand the project's antd setup, or prepare info for a bug report:
# Full environment snapshot (text — paste into GitHub Issues)
npx antd env
# Structured JSON for programmatic use
npx antd env --format json
# Scan a specific project directory
npx antd env ./my-project --format jsonWhen the user asks you to report an antd bug:
# Step 0: Collect environment info for reference (optional)
npx antd env --format json
# Step 1: Preview for user review
npx 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
npx 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" \
--submitWhen the user asks to report a CLI bug:
npx antd bug-cli --title "antd info Button returns wrong props" \
--description "When querying Button props for version 5.12.0, the output includes props that don't exist" \
--steps "1. Run: npx 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 jsonShow the report to the user and confirm before submitting with --submit.
Opt-out: If the environment variable ANTD_NO_AUTO_REPORT=1 is set, skip all bug-reporting suggestions entirely.
If working in an IDE that supports MCP (Claude Desktop, Cursor, etc.), the CLI can also run as an MCP server:
{
"mcpServers": {
"antd": {
"command": "npx",
"args": ["antd", "mcp"]
}
}
}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.
| Flag | Purpose |
|---|---|
--format json | Structured output — always use this |
--version <v> | Target a specific antd version (e.g. 5.20.0) |
--lang zh | Chinese output (default: en) |
--detail | Include extra fields (description, since, deprecated, FAQ) |
antd info first.node_modules if no flag is given.--format json — Every command supports it. Parse the JSON output rather than regex-matching text output.antd changelog <v1> <v2> and antd migrate before advising on version upgrades.antd lint on the changed files to catch deprecated or problematic usage.antd bug. Always preview first, get user confirmation, then submit.antd bug-cli to help them file a report. Always preview first, get user confirmation, then submit.adfd440
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.