OverviewHistoryStatsSecurity
npx skills add ...
Documentation
SKILL.md
npx skills add ant-design/ant-design-cli --skill antd
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.
npx skills add ant-design/ant-design-cli --skill antd
You have access to @ant-design/cli — a local CLI tool with bundled antd metadata for v4/v5/v6 (plus migration guides for v3 → v4, v4 → v5, v5 → v6). Use it to query component knowledge, analyze projects, and guide migrations. All data is offline, no network needed.
Before first use, check if the CLI is installed. If not, install it automatically:
After running any command, if the output contains an "Update available" notice, run antd upgrade to update before continuing.
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.
Workflow: antd info → understand props → antd demo → grab a working example → write code.
When you need comprehensive component docs (not just props):
When code isn't working as expected or the user reports an antd bug:
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.
When the user wants to upgrade antd (e.g., v3 → v4 or v4 → v5):
Workflow: 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:
When the user asks about what changed in a version:
When the user is choosing which component to use:
When you need to understand the project's antd setup, or prepare info for a bug report:
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.).
When the user asks you to report an antd bug:
When the user asks you to report a CLI bug, or explicitly requests help filing one:
Show the report to the user and confirm before submitting:
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.
When the user wants to update @ant-design/cli to the latest version, or when an "Update available" notice appears:
The command detects which package manager installed the CLI (npm, yarn, pnpm, bun, cnpm, utoo) and runs the appropriate upgrade command. If detection fails, it suggests the manual command.
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:
This provides 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) via MCP protocol.
| Flag | Purpose |
|---|---|
--format <format> | Output format: json, text, or markdown (agents should prefer json) |
--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) |
-V, --cli-version | Print CLI version and exit |
antd info first.list/info/doc/demo/token/semantic/changelog) support antd v4+. If the project uses antd 4.x/5.x/6.x, pass --version 4.24.0 / 5.24.0 / 6.x. For antd v3 projects, use antd migrate 3 4 first.--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.antd doc Table --format json # full markdown docs for Table
antd doc Table --lang zh # Chinese docs# 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# 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
# Generate agent-friendly auto-migration prompt (does not modify files)
antd migrate 4 5 --apply ./src --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# 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# 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# List all components with categories
antd list --format json
# List components for a specific antd version
antd list --version 5.0.0 --format json# 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# 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# 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 jsonantd bug-cli --title "antd info Button returns wrong props for v5.12.0" \
--description "..." \
--steps "..." \
--expected "..." \
--actual "..." \
--submit# Upgrade to the latest version (auto-detects package manager)
antd upgrade{
"mcpServers": {
"antd": {
"command": "antd",
"args": ["mcp", "--version", "5.20.0"]
}
}
}