Create CLI
CLI 인터페이스 영역(구문 + 동작)을 인간 중심으로, 스크립트에도 친화적으로 설계합니다.
먼저 할 일
agent-scripts/skills/create-cli/references/cli-guidelines.md를 읽고 기본 평가 기준으로 적용하세요.- 상위/전체 가이드라인: https://clig.dev/ (변경 제안: https://github.com/cli-guidelines/cli-guidelines)
- 인터페이스를 확정하는 데 필요한 최소한의 질문만 하세요.
명확히 하기 (빠르게)
질문한 후, 사용자가 확신하지 못하면 최선의 기본값으로 진행하세요:
- 명령어 이름 + 한 문장 목적.
- 주요 사용자: 사람, 스크립트, 또는 둘 다.
- 입력 소스: 인수 vs stdin; 파일 vs URL; 비밀(절대 플래그로 전달 금지).
- 출력 계약: 사람용 텍스트,
--json,--plain, 종료 코드. - 상호작용성: 프롬프트 허용?
--no-input필요? 파괴적 작업에 확인? - 구성 모델: 플래그/환경 변수/설정 파일; 우선순위; XDG vs 저장소 로컬.
- 플랫폼/런타임 제약: macOS/Linux/Windows; 단일 바이너리 vs 런타임.
결과물 (출력할 내용)
CLI를 설계할 때 사용자가 구현할 수 있는 간결한 사양을 생성하세요:
- 명령어 트리 + USAGE 개요.
- 인수/플래그 표 (타입, 기본값, 필수/선택, 예시).
- 서브커맨드 의미론 (각각의 기능; 멱등성; 상태 변경).
- 출력 규칙: stdout vs stderr; TTY 감지;
--json/--plain;--quiet/--verbose. - 오류 + 종료 코드 맵 (주요 실패 모드).
- 안전 규칙:
--dry-run, 확인,--force,--no-input. - 구성/환경 변수 규칙 + 우선순위 (플래그 > 환경 변수 > 프로젝트 설정 > 사용자 설정 > 시스템).
- 셸 완성 (해당되는 경우): 설치/검색 가능성; 생성 명령어 또는 번들 스크립트.
- 예제 호출 5~10개 (일반적인 흐름; 파이프/stdin 예제 포함).
기본 규칙 (사용자가 달리 명시하지 않는 한)
-h/--help는 항상 도움말을 표시하고 다른 인수를 무시합니다.--version은 버전을 stdout에 출력합니다.- 주요 데이터는 stdout으로; 진단/오류는 stderr로.
- 기계 출력을 위해
--json을 추가하고, 안정적인 줄 기반 텍스트를 위해--plain을 고려하세요. - 프롬프트는 stdin이 TTY인 경우에만;
--no-input은 프롬프트를 비활성화합니다. - 파괴적 작업: 대화형 확인 + 비대화형에서는
--force또는 명시적--confirm=...필요. NO_COLOR,TERM=dumb를 존중하고--no-color를 제공하세요.- Ctrl-C 처리: 빠르게 종료; 제한된 정리; 가능하면 crash-only로 처리.
템플릿 (답변에 복사하여 사용)
CLI 사양 뼈대
다음 섹션을 채우고 관련 없는 부분은 제거하세요:
- 이름:
mycmd - 한 줄 설명:
... - USAGE:
mycmd [global flags] <subcommand> [args]
- 서브커맨드:
mycmd init ...mycmd run ...
- 글로벌 플래그:
-h, --help--version-q, --quiet/-v, --verbose(정확히 정의)--json/--plain(해당되는 경우)
- I/O 계약:
- stdout:
- stderr:
- 종료 코드:
0성공1일반 실패2잘못된 사용 (파싱/검증)- (실제로 유용할 때만 명령어별 코드 추가)
- 환경 변수/설정:
- 환경 변수:
- 설정 파일 경로 + 우선순위:
- 예제:
- …
참고
- 언어별 파싱 라이브러리는 요청 시에만 추천하며, 그렇지 않으면 이 스킬을 언어에 구애받지 않게 유지하세요.
- 요청이 "설계 매개변수"인 경우 구현 세부 사항으로 빠지지 마세요.