CLI

This guide explains how to use @ant-design/cli to query Ant Design component knowledge, analyze project usage, and guide migrations from the command line.

What is Ant Design CLI?

@ant-design/cli is an official command-line tool that brings Ant Design knowledge to your terminal. It ships all metadata locally — every prop, token, demo, and changelog entry for antd v3 / v4 / v5 / v6 — queryable in milliseconds, fully offline.

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 any version.
• Agent-optimized — --format json on every command. Structured errors with codes and suggestions.
• 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.
• 18 commands — From prop lookup to project-wide lint, from design tokens to MCP/Skill setup.

Install

npm install -g @ant-design/cli

Requires Node.js >=20.0.0. You can also install globally with pnpm add -g @ant-design/cli or bun add -g @ant-design/cli.

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

antd design.md {#design-md}

antd design.md outputs the design language description file for Ant Design, conformant with the google-labs-code/design.md specification. This file is intended for AI design tools (Figma Make, Google Stitch, etc.) so they can generate UI that follows Ant Design's visual language.

antd design.md                # Output the full design.md content
antd design.md --format json  # JSON format output
antd design.md --lang zh      # Chinese descriptions

The file includes:

• YAML front-matter — Structured token definitions for colors, typography, rounded corners, spacing, and core components, with {path.to.token} reference syntax
• Overview — Ant Design's four design values (Natural, Certain, Meaningful, Growing)
• Colors — Functional colors, preset palette, and why neutrals use rgba()
• Typography — 14px base font size, font stack, two-weight constraint
• Layout — 4px grid, spacing scale, three-layer surface model
• Elevation & Depth — Four shadow tiers, motion durations and easings
• Shapes — 6px default radius and per-component classifications
• Components — Style descriptions for core component archetypes and states
• Do's and Don'ts — Design guidance rules

The file is also published at ant.design/design.md and can be read directly by AI tools via URL.

Project Analysis

Issue Reporting

CLI Management

The antd mcp command launches a Model Context Protocol server, allowing AI assistants to access Ant Design knowledge directly. See the MCP Server guide for full details and configuration.

The antd setup command can write MCP configuration, install the bundled Ant Design skill, or both:

antd setup --client claude
antd setup --client cursor --mode both
antd setup --client vscode --write-instructions
antd setup --client codex
antd setup --client claude --dry-run
antd setup --client claude --check

Global Flags

Version auto-detection order: --version flag, node_modules/antd, package.json dependencies, then fallback.

Environment Variables

Usage with AI Tools

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

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

Works with any agent supporting the skills protocol.

Learn More

• @ant-design/cli on GitHub
• @ant-design/cli on npm
• Ant Design LLMs.txt Guide
• Ant Design MCP Server