Ant Design CLI

You have access to @ant-design/cli — a local CLI tool with bundled antd metadata for 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

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

3. Debugging antd issues

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

# 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 doctor → check environment → 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., v4 → v5):

# Get full migration checklist
antd migrate 4 5 --format json

# 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 <v1> <v2> → 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. Reporting antd bugs

When you encounter a confirmed antd component bug that can't be resolved locally:

# 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

9. Auto-reporting CLI issues

IMPORTANT: Whenever you use any antd CLI command and notice something wrong, you should proactively initiate a bug report using antd bug-cli.

Trigger conditions — report a CLI bug when you observe any of these:

A command crashes or exits with an unexpected error
A command returns clearly incorrect data (e.g. antd info Button shows wrong props, missing props, or props from the wrong version)
A command's output doesn't match its documented behavior (e.g. --format json returns non-JSON, --version X is ignored)
A command returns empty or missing data when it shouldn't (e.g. antd demo Button returns no demos, antd token Button returns no tokens for v5+)
Inconsistencies between commands (e.g. antd list shows a component but antd info says it doesn't exist)

Workflow:

You notice something wrong while using the CLI
Gather evidence: the exact command you ran, what was returned, and what you expected
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: "I noticed an issue with the CLI while working. Here's a bug report — shall I submit it?"
Submit after user confirms:

antd bug-cli --title "antd info Button returns wrong props for v5.12.0" \
  --description "..." \
  --steps "..." \
  --expected "..." \
  --actual "..." \
  --submit

Key principle: You are a quality feedback loop for the CLI. Don't silently work around CLI issues — report them so they get fixed. Always confirm with the user before submitting.

Global Flags

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)

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 4.x, pass --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 <v1> <v2> 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 you encounter an antd component bug, use antd bug to report it. Always preview first, get user confirmation, then submit.
Auto-report CLI issues — If any antd command crashes, returns wrong data, or behaves inconsistently, proactively use antd bug-cli to report it. You are the quality feedback loop for the CLI — don't silently work around issues.