antd list command
antd list displays all components with bilingual names, categories, and the version in which they were introduced.
cli/commands
28 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.
antd info command
antd info <Component> displays a Props table containing type, default value, version introduced, and deprecation status for a component.
antd doc command
antd doc <Component> outputs the complete Markdown documentation for a component.
antd demo command
antd demo <Component> [name] displays runnable Demo source code in TSX format.
antd token command
antd token [Component] displays global or component-level Design Tokens.
antd design.md command
antd design.md outputs Ant Design's design language description file following the google-labs-code/design.md specification. The file is intended for AI design tools like Figma Make and Google Stitch. Use --format json for JSON output and --lang zh for Chinese descriptions.
design.md file structure
The design.md file contains: YAML Front Matter with structured Token definitions for colors, fonts, border radius, spacing and core components supporting {path.to.token} reference syntax; Design Overview of Ant Design's four design values (natural, certain, meaningful, growth); Color System explaining functional colors, preset palettes, and neutral colors using rgba(); Typography with 14px base font size, font stack, and two weight restrictions; Layout with 4px grid, spacing scale, and three-layer surface model; Hierarchy and Depth with four levels of shadows, animation duration and easing functions; Shape with 6px default border radius; Components with core component prototypes and style descriptions; and Design Guidelines with Do's and Don'ts rules.
antd semantic command
antd semantic <Component> displays semantic classNames and styles structure with usage examples.
antd changelog command
antd changelog [v1] [v2] [component] displays Changelog entries, version ranges, or cross-version API comparisons.
antd doctor command
antd doctor performs 10 diagnostic checks: React compatibility, duplicate installations, peer dependencies, SSR, and babel plugin configuration.
antd env command
antd env [dir] collects antd-related environment information in one command for Bug reports or AI-assisted diagnosis.
antd usage command
antd usage [dir] analyzes antd imports in the project, showing import statistics, sub-component distribution (e.g., Form.Item), and non-component exports.
antd lint command
antd lint [target] checks for deprecated APIs, accessibility defects, performance issues, and best practices.
antd migrate command
antd migrate <from> <to> displays a migration checklist distinguishing between auto-fixes and manual handling. Use --apply to generate Agent migration suggestions.
antd mcp command
antd mcp starts a Model Context Protocol server providing 8 tools and 2 prompts, supporting IDE integration with Claude Code, Cursor, VS Code, and other clients.
antd setup command
antd setup configures MCP, installs built-in Ant Design Skill, or both. Syntax: antd setup --client <claude|cursor|vscode|codex> [--mode both] [--write-instructions] [--dry-run] [--check]
antd upgrade command
antd upgrade upgrades the CLI to the latest version.
antd bug and antd bug-cli commands
antd bug submits a Bug to the ant-design repository. antd bug-cli submits a Bug to the ant-design-cli repository.
antd design.md file availability
The design.md file is published at ant.design/design.md and can be read directly via URL by AI tools.
Development commands reference
Common npm/yarn commands: npm start or yarn start to run the local website; npm run lint or yarn lint for code style checking; npm test or yarn test to run tests (ensure NODE_ENV is not set before testing); npm run compile or yarn compile to compile TypeScript to lib and es directories; npm run dist or yarn dist to build UMD version to dist directory.
Test running during development
During development, use npm test -- --watch TestName to run specific tests without running the full test suite.
design.md access via CLI
The design.md content can be retrieved through the @ant-design/cli using the command: antd design.md
design.md CLI format options
The antd design.md command supports the following options: --format json (outputs in JSON format) and --lang zh (outputs in Chinese descriptions).
Accessing design.md via CLI
The design.md content can be retrieved through the @ant-design/cli tool using the command 'antd design.md'. Common options include --format json for JSON output and --lang zh for Chinese descriptions.
CLI commands available in @ant-design/cli
The @ant-design/cli tool provides these commands: antd list (all components with versions), antd info <Component> (component props, types, defaults), antd doc <Component> (full markdown documentation), antd demo <Component> <demo> (runnable demo source code), antd token <Component> (design token values for v5+), antd design.md (design-language document), antd semantic <Component> (classNames / styles structure), antd changelog <version1> <version2> <Component> (API diff across versions), antd doctor (diagnose project issues), antd env (collect env info for bug reports), antd usage <path> (analyze antd imports in project), antd lint <path> (check deprecated APIs and best practices), antd migrate <version1> <version2> (migration guide), antd migrate <version1> <version2> --apply <path> (agent-ready migration prompt), antd mcp (start MCP server for IDE integration), antd setup --client <client> (set up MCP/Skill for AI agents), antd upgrade (upgrade CLI to latest version)
CLI commands reference
antd list — shows all components and version information. antd info Button — displays component Props, types, and default values. antd doc Button — shows complete Markdown documentation. antd demo Select basic — provides runnable Demo source code. antd token DatePicker — displays Design Token values (v5+). antd design.md — shows design language documentation. antd semantic Table — displays classNames/styles structure. antd changelog 4.24.0 5.0.0 Select — shows cross-version API differences. antd doctor — diagnoses project configuration issues. antd env — collects environment information for bug reports. antd usage ./src — analyzes antd imports in project. antd lint ./src — checks deprecated APIs and best practices. antd migrate 3 4 — shows v3 to v4 migration guide. antd migrate 4 5 --apply ./src — generates agent migration suggestions. antd mcp — starts MCP server for IDE integration. antd setup --client claude — connects AI Agent to MCP/Skill. antd upgrade — upgrades CLI to latest version.
CLI setup commands for MCP configuration
The CLI provides 'antd setup' commands to write supported project configuration automatically. Supported clients are: claude, cursor, vscode, and codex. Setup modes are: mcp, skill, and both. Example commands: antd setup --client claude, antd setup --client cursor --mode both, antd setup --client vscode --write-instructions, antd setup --client claude --dry-run, antd setup --client claude --check
antd setup command for automatic IDE configuration
The CLI can automatically write supported project configurations using `antd setup` with options: --client (claude, cursor, vscode, or codex), --mode (mcp, skill, or both), --write-instructions, --dry-run, or --check.