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

Install

bash

npm install -g @ant-design/cli

Quick Start

bash

antd info Button                    # Component props, types, defaults
antd demo Select basic              # Runnable demo source code
antd token DatePicker               # Design Token values (v5+)
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 lint ./src                     # Check deprecated APIs & best practices
antd migrate 4 5 --apply ./src      # Agent-ready migration prompt

Commands

Knowledge Query

Command	Description
`antd list`	List all components with bilingual names, categories, and `since` versions
`antd info <Component>`	Props table with types, defaults, `since`, and deprecated status
`antd doc <Component>`	Full markdown documentation for a component
`antd demo <Component> [name]`	Runnable demo source code (TSX)
`antd token [Component]`	Global or component-level Design Tokens
`antd semantic <Component>`	Semantic `classNames` / `styles` structure with usage examples
`antd changelog [v1] [v2] [component]`	Changelog entries, version ranges, or cross-version API diff

Project Analysis

Command	Description
`antd doctor`	10 diagnostic checks: React compat, duplicates, peer deps, SSR, babel plugins
`antd usage [dir]`	Import stats, sub-component breakdown (`Form.Item`), non-component exports
`antd lint [target]`	Deprecated APIs, accessibility gaps, performance issues, best practices
`antd migrate <from> <to>`	Migration checklist with auto-fixable/manual split and `--apply` agent prompt

Global Flags

Flag	Description	Default
`--format json\|text\|markdown`	Output format	`text`
`--version <v>`	Target antd version (e.g. `5.20.0`)	auto-detect
`--lang en\|zh`	Output language	`en`
`--detail`	Include extended information	`false`

Usage with AI Tools

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

bash

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

Tool	Description
Claude Code	Install as agent skill or use `antd` commands directly in terminal. Documentation
Cursor	Install skill, the agent will call CLI commands automatically. Documentation
Codex	Install skill to enable agent access. Documentation
Gemini CLI	Install skill for automatic command invocation. Documentation

Works with any agent supporting the skills protocol.

Learn More

contributors