Ant Design CLI

Ant Design CLI

이 가이드는 @ant-design/cli를 사용해 Ant Design 컴포넌트 지식을 조회하고, 프로젝트 사용 현황을 분석하며, 커맨드 라인에서 마이그레이션을 안내받는 방법을 설명해요.

출처: 문서

본문

Ant Design CLI란 무엇인가요?

@ant-design/cli는 Ant Design 지식을 터미널로 가져오는 공식 커맨드라인 도구예요. 모든 메타데이터를 로컬에 함께 내장해서 — antd v3 / v4 / v5 / v6의 모든 prop, 토큰, 데모, 체인지로그 항목을 밀리초 단위로, 완전히 오프라인에서 조회할 수 있어요.

특징 (Highlights)

  • 완전 오프라인 (Fully offline) — 모든 메타데이터가 패키지에 함께 내장돼요. 네트워크 호출도, 지연도, API 키도 없어요.
  • 버전 정확 (Version-accurate) — v3/v4/v5/v6에 걸쳐 55개 이상의 마이너 버전 스냅샷을 제공해요. 어떤 버전의 정확한 API 표면도 조회할 수 있어요.
  • 에이전트 최적화 (Agent-optimized) — 모든 명령에 --format json을 지원하고, 코드와 제안이 포함된 구조화된 오류를 반환해요.
  • 이중 언어 (Bilingual) — 모든 컴포넌트 이름·설명·문서가 영어와 중국어를 모두 가져요. --lang zh로 전환할 수 있어요.
  • 스마트 매칭 (Smart matching) — Buttn 같은 오타도? CLI가 Levenshtein 거리를 사용해 Button을 제안해 줘요.
  • 18개 명령 (18 commands) — prop 조회부터 프로젝트 전반의 lint, 디자인 토큰부터 MCP/Skill 설정까지.

설치 (Install)

npm install -g @ant-design/cli

Node.js >=20.0.0가 필요해요. pnpm add -g @ant-design/cli나 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 list 이중 언어 이름, 카테고리, since 버전과 함께 모든 컴포넌트 나열
antd info <Component> 타입, 기본값, since, 폐기(deprecated) 상태가 포함된 props 표
antd doc <Component> 컴포넌트의 전체 마크다운 문서
antd demo <Component> [name] 실행 가능한 데모 소스 코드 (TSX)
antd token [Component] 전역 또는 컴포넌트 수준의 Design Token
antd design.md AI 디자인 도구용 디자인 언어 문서
antd semantic <Component> 사용 예시가 포함된 시맨틱 classNames / styles 구조
antd changelog [v1] [v2] [component] 체인지로그 항목, 버전 범위, 또는 버전 간 API 차이

antd design.md {#design-md}

antd design.md는 google-labs-code/design.md 스펙에 부합하는 Ant Design의 디자인 언어 설명 파일을 출력해요. 이 파일은 AI 디자인 도구(Figma Make, Google Stitch 등)가 Ant Design의 비주얼 언어를 따르는 UI를 생성할 수 있게 하기 위한 것이에요.

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

이 파일에는 다음이 포함돼요.

  • YAML front-matter — 색, 타이포그래피, 라운드 코너, 간격, 핵심 컴포넌트에 대한 구조화된 토큰 정의 ({path.to.token} 참조 문법 포함)
  • Overview — Ant Design의 네 가지 디자인 가치 (Natural, Certain, Meaningful, Growing)
  • Colors — 기능 색, 프리셋 팔레트, 중성색에 rgba()를 쓰는 이유
  • Typography — 14px 기본 폰트 크기, 폰트 스택, 두 가지 두께 제약
  • Layout — 4px 그리드, 간격 스케일, 3계층 표면 모델
  • Elevation & Depth — 네 가지 그림자 단계, 모션 지속시간과 easing
  • Shapes — 6px 기본 반지름과 컴포넌트별 분류
  • Components — 핵심 컴포넌트 원형(archetype)과 상태에 대한 스타일 설명
  • Do's and Don'ts — 디자인 가이드 규칙

이 파일은 또한 ant.design/design.md로 게시되어 있어서 AI 도구가 URL로 직접 읽을 수 있어요.

프로젝트 분석 (Project Analysis)

명령 설명
antd doctor 10가지 진단 검사: React 호환성, 중복, peer deps, SSR, babel 플러그인
antd env [dir] 버그 리포트나 AI 진단을 위한 모든 antd 관련 환경 정보 수집
antd usage [dir] import 통계, 하위 컴포넌트 분석(Form.Item), 비컴포넌트 export
antd lint [target] 폐기된 API, 접근성 격차, 성능 문제, 모범 사례
antd migrate <from> <to> 자동 수정 가능/수동 항목 분리와 --apply 에이전트 프롬프트가 있는 마이그레이션 체크리스트

이슈 보고 (Issue Reporting)

명령 설명
antd bug ant-design 저장소에 버그 제출
antd bug-cli ant-design-cli 저장소에 버그 제출

CLI 관리 (CLI Management)

명령 설명
antd mcp IDE 통합(Claude Code, Cursor, VS Code 등)을 위한 8개 도구와 2개 프롬프트를 가진 MCP 서버 시작
antd setup Claude Code, Cursor, VS Code, Codex용 Ant Design MCP/Skill 설정
antd upgrade CLI를 최신 버전으로 업그레이드

antd mcp 명령은 Model Context Protocol 서버를 실행해 AI 어시스턴트가 Ant Design 지식에 직접 접근할 수 있게 해 줘요. 전체 상세 내용과 설정은 MCP 서버 가이드를 참고하세요.

antd setup 명령은 MCP 설정을 작성하거나, 내장된 Ant Design 스킬을 설치하거나, 둘 다 할 수 있어요.

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)

플래그 설명 기본값
--format json|text|markdown 출력 형식 text
--version <v> 대상 antd 버전 (예: 5.20.0) auto-detect
--lang en|zh 출력 언어 en
--detail 확장 정보 포함 false
-V, --cli-version CLI 버전 출력 -

버전 자동 감지 순서: --version 플래그, node_modules/antd, package.json 의존성, 그다음 fallback.

환경 변수 (Environment Variables)

변수 설명
ANTD_NO_AUTO_REPORT=1 AI 에이전트 버그 보고 제안 비활성화
NO_UPDATE_CHECK=1 조용한 버전 업데이트 확인 건너뛰기
CI=1 조용한 버전 업데이트 확인 건너뛰기. NO_UPDATE_CHECK=1와 동일

AI 도구와 함께 사용하기

CLI는 코드 에이전트에게 각 명령을 언제, 어떻게 사용하는지 가르치는 내장 스킬 파일과 함께 배포돼요.

npx skills add ant-design/ant-design-cli
도구 설명
Claude Code 에이전트 스킬로 설치하거나 터미널에서 antd 명령을 직접 사용. 문서
Cursor 스킬을 설치하면 에이전트가 CLI 명령을 자동 호출. 문서
Codex 스킬을 설치해 에이전트 접근 활성화. 문서
Gemini CLI 자동 명령 호출을 위해 스킬 설치. 문서

skills 프로토콜을 지원하는 모든 에이전트와 함께 동작해요.

더 알아보기