Agent skill

Ant Design CLI

by ant-design in ant-design/antd-skill

Looks up antd component props, docs, demos and changelogs with the offline @ant-design/cli, and helps debug, migrate between versions and audit usage in a project.

MITAuto-check passedFrontend & Design

Install Ant Design CLI

skills CLI
$ npx skills add ant-design/antd-skill --skill antd -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ant-design/antd-skill antd --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ant-design/antd-skill.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/antd .claude/skills/antd && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
antd
GitHub stars
136
Token cost
~2.2k tokens
SKILL.md length
733 words
Files
2
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Looks up antd component props, docs, demos and changelogs with the offline @ant-design/cli, and helps debug, migrate between versions and audit usage in a project.

  • Works in 10 steps: Writing antd component code → Looking up full documentation → Debugging antd issues → …
  • Writing antd components and checking the real prop list first
  • SKILL.md covers Setup, Scenarios, Global Flags and Key Rules
  • Calls npm; reaches codesandbox.io

What it does

The skill relies on @ant-design/cli, a local command-line tool with bundled antd metadata for v4, v5 and v6, so lookups work offline. The agent installs it globally if the antd command is missing and asks for JSON output so results can be parsed. Before writing any component code it checks the real API with antd info, then pulls a working example with antd demo instead of relying on memory.

Other scenarios follow the same pattern: antd doc for full documentation, with a Chinese option; antd doctor and antd lint to find environment problems and deprecated or incorrect usage against the exact version in the project; antd migrate and antd changelog for moving between versions such as v4 to v5; antd usage to scan which components a source folder uses; and commands for browsing the available components.

When your agent uses it

  • Writing antd components and checking the real prop list first
  • Debugging an antd prop that behaves differently on one version
  • Planning an upgrade from antd v4 to v5
  • Scanning a project to see which antd components it uses
  • Looking up what changed in a given antd release

Example prompts

  • “Build a settings form with antd and check the Select props before you write it.”
  • “Migrate this project from antd v4 to v5 and list the breaking changes first.”
  • “Scan ./src and tell me which antd components we use most.”
  • “Lint this file for deprecated antd usage against the version in package.json.”

Requirements

  • Node.js and npm, to install @ant-design/cli globally
  • Pre-approved tools (allowed-tools): Bash(antd *), Bash(antd bug*), Bash(antd bug-cli*), Bash(npm install -g @ant-design/cli*), Bash(which antd)

Workflow steps

10 steps, taken from the step headings in SKILL.md.

  1. Writing antd component code
  2. Looking up full documentation
  3. Debugging antd issues
  4. Migrating between versions
  5. Analyzing project antd usage
  6. Checking changelogs and version history
  7. Exploring available components
  8. Reporting antd bugs
  9. Auto-reporting CLI issues
  10. Using as MCP server

What it can do on your machine

Read from SKILL.md and the folder at commit e65d2d3. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Bash(antd *)
    • Bash(antd bug*)
    • Bash(antd bug-cli*)
    • Bash(npm install -g @ant-design/cli*)
    • Bash(which antd)

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • codesandbox.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Ant Design CLI loads about 2.2k tokens when it runs. Until then it costs about 74 tokens; SKILL.md has 733 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~74
When it runs · the whole SKILL.md, loaded when a task matches
~2.2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ant-design/antd-skill at commit e65d2d3, republished under its MIT licence (© ant-design). 733 words, ~2,161 tokens.

Download SKILL.mdSave it as .claude/skills/antd/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
antd
description
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.
allowed-tools
Bash(antd *), Bash(antd bug*), Bash(antd bug-cli*), Bash(npm install -g @ant-design/cli*), Bash(which antd)

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:

bash
which antd || npm install -g @ant-design/cli

After running any command, if the output contains an "Update available" notice, run npm install -g @ant-design/cli to update before continuing.

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.

bash
# 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):

bash
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:

bash
# 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):

bash
# 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:

bash
# 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:

bash
# 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:

bash
# 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:

bash
# 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:

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

Show full SKILL.md (244 more words)Show less
10. Using as MCP server

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:

json
{
  "mcpServers": {
    "antd": {
      "command": "antd",
      "args": ["mcp", "--version", "5.20.0"]
    }
  }
}

This provides 7 tools (antd_list, antd_info, antd_doc, antd_demo, antd_token, antd_semantic, antd_changelog) and 2 prompts (antd-expert, antd-page-generator) via MCP protocol.

Global Flags

FlagPurpose
--format jsonStructured output — always use this
--version <v>Target a specific antd version (e.g. 5.20.0)
--lang zhChinese output (default: en)
--detailInclude extra fields (description, since, deprecated, FAQ)

Key Rules

  1. Always query before writing — Don't guess antd APIs from memory. Run antd info first.
  2. 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.
  3. Use --format json — Every command supports it. Parse the JSON output rather than regex-matching text output.
  4. Check before suggesting migration — Run antd changelog <v1> <v2> and antd migrate before advising on version upgrades.
  5. Lint after changes — After writing or modifying antd code, run antd lint on the changed files to catch deprecated or problematic usage.
  6. Report antd bugs — When you encounter an antd component bug, use antd bug to report it. Always preview first, get user confirmation, then submit.
  7. 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.

© ant-design, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in skills/antd of ant-design/antd-skill.

  • SKILL.md
  • LICENSE

Open the folder on GitHubat commit e65d2d3

Compare with similar skills

Ant Design CLI next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Ant Design CLI compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Ant Design CLI this skillant-design/antd-skill136—~2.2kAutomated safety check: PassMIT
Frontendstreamband/hydra-srt146—~582Automated safety check: PassApache-2.0
Renovate Reviewcommercetools/ui-kit154—~907Automated safety check: NotesMIT
LobeHub Interactive Prototypelobehub/lobehub83k—~1.6kAutomated safety check: PassCustom licence
Integrating shadcn/ui Componentsgoogle-labs-code/stitch-skills8.4k4 repos~2.3kAutomated safety check: NotesApache-2.0
GSAP for Reactgreensock/gsap-skills16k4 repos~1.6kAutomated safety check: PassMIT

Similar skills

  • Frontend

    streamband/hydra-srt

    A skill your agent uses for frontend work in webapp (React/TypeScript, UI implementation, tests, and refactors).

    146 GitHub stars~582 tokensUpdated 22 days ago
    Frontend & DesignAuto-check passed
  • Renovate Review

    commercetools/ui-kit

    Review Renovate dependency upgrade PRs to assess safety and effort.

    154 GitHub stars~907 tokensUpdated 5 days ago
    Frontend & DesignAuto-check: notes
  • Builds single-file interactive HTML prototypes rendered with the real LobeHub UI components and written as production-style React, so they can later be split into files.

    83k GitHub stars~1.6k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Integrating shadcn/ui Components

    google-labs-code/stitch-skills

    Official

    Guides finding, installing, customizing and wiring up shadcn/ui components in a project, with MCP tools for the component catalog and registries.

    8.4k GitHub starsUsed in 4 repos~2.3k tokens
    Frontend & DesignAuto-check: notes
  • GSAP for React

    greensock/gsap-skills

    Shows how to run GSAP animations in React and Next.js with the useGSAP hook, refs, scoped selectors and automatic cleanup on unmount.

    16k GitHub starsUsed in 4 repos~1.6k tokens
    Frontend & DesignAuto-check passed
  • Chakra UI v2 to v3 Migration

    chakra-ui/chakra-ui

    Guides an upgrade from Chakra UI v2 to v3: inspect the project, swap packages, run the official codemod, then fix provider, color mode, props, theming and Next.js code.

    41k GitHub stars~3.4k tokensUpdated yesterday
    Frontend & DesignAuto-check passed

Works with

Questions about Ant Design CLI

What does Ant Design CLI do?

Looks up antd component props, docs, demos and changelogs with the offline @ant-design/cli, and helps debug, migrate between versions and audit usage in a project. The skill relies on @ant-design/cli, a local command-line tool with bundled antd metadata for v4, v5 and v6, so lookups work offline. The agent installs it globally if the antd command is missing and asks for JSON output so results can be parsed.

When should I use Ant Design CLI?

Ant Design CLI fits situations like: writing antd components and checking the real prop list first; debugging an antd prop that behaves differently on one version; planning an upgrade from antd v4 to v5; scanning a project to see which antd components it uses.

How do I install Ant Design CLI in Claude Code?

Run `npx skills add ant-design/antd-skill --skill antd -a claude-code`. Or copy the skill folder (skills/antd in ant-design/antd-skill) into .claude/skills/antd in your project. Claude Code loads it when a task matches its description.

How do I install Ant Design CLI in Codex?

Run `npx skills add ant-design/antd-skill --skill antd -a codex`. Or copy the skill folder (skills/antd in ant-design/antd-skill) into .agents/skills/antd in your project. Codex loads it when a task matches its description.

Can I use Ant Design CLI in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ant-design/antd-skill --skill antd -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/antd, .gemini/skills/antd, .github/skills/antd and .opencode/skills/antd in your project.

What does Ant Design CLI need to run?

Going by SKILL.md and its folder, Ant Design CLI needs the command-line tools its instructions call (npm). Our summary lists: Node.js and npm, to install @ant-design/cli globally. Its frontmatter pre-approves these tools: Bash(antd *), Bash(antd bug*), Bash(antd bug-cli*), Bash(npm install -g @ant-design/cli*), Bash(which antd).

Does Ant Design CLI access the network?

SKILL.md names 1 domain. In commands or code: codesandbox.io; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Ant Design CLI safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Ant Design CLI use?

Ant Design CLI is published under the MIT licence (from the LICENSE file in the skill folder). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Ant Design CLI use?

About 2.2k tokens (SKILL.md is roughly 8.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Ant Design CLI?

Skills that share tags, products or a category with Ant Design CLI: Frontend (streamband/hydra-srt, 146 stars), Renovate Review (commercetools/ui-kit, 154 stars), LobeHub Interactive Prototype (lobehub/lobehub, 83k stars) and Integrating shadcn/ui Components (google-labs-code/stitch-skills, 8.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Ant Design CLI?

ant-design (a GitHub organization) maintains it in ant-design/antd-skill, which has 136 GitHub stars. The repository was last updated on March 27, 2026.

Source: ant-design/antd-skill on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.