CLI 참조

apothem 명령줄 인터페이스는 공유 프로필로부터 하니스 어댑터 구성을 관리합니다. 아래의 각 페이지는 하위 명령 하나를 문서화합니다. 그 개요, 옵션, 동작, 종료 코드입니다.

install, update, uninstall은 각각 연속형 별칭(installing, updating, uninstalling)도 받으며, 이 별칭은 플래그와 동작이 기본 명령과 동일합니다. 설치 채널 — Claude Code 플러그인, npx, 원샷 설치 스크립트 — 을 통한 업데이트와 제거는 별칭 자체가 아니라 업데이트 및 제거 설치 가이드에 문서화되어 있습니다.

명령Copy Anchor Link

JSON 출력 계약Copy Anchor Link

completion(셸 스크립트를 출력함)을 제외한 모든 명령은 --json (--format json의 축약형)을 받으며, 그 경우 stdout에 정확히 하나의 JSON 문서를 씁니다. 각 문서는 최상위 schema_version 키로 시작하며, 이 키는 현재 1인 정수입니다.

{"schema_version": 1, "status": "success", "command": "verify", "...": "..."}

• 안정성. 하나의 schema_version 안에서 변경은 추가형입니다. 새 키가 나타날 수는 있지만, 어떤 키도 이름이 바뀌거나 제거되지 않으며 어떤 값도 타입이 바뀌지 않습니다. 그 밖의 모든 변경은 schema_version을 올립니다.
• 버전이 매겨진 아티팩트. profile show --json은 프로필 자체를 출력하므로, 그 schema_version은 프로필 스키마 버전입니다(이 역시 현재 1).
• 하나의 예외. harnesses list --json은 예전부터 그래 왔듯이 JSON 배열(하니스당 객체 하나)을 출력하므로, 버전을 담을 최상위 키가 없습니다. 이를 객체로 감싸면 기존 파서가 깨집니다. 버전 증가로 그렇게 바뀔 때까지는 그 형태를 schema_version 1로 취급하세요.
• 오류. 예상된 실패는 같은 문서 형태에 "status": "error"와 code, field, reason, fix를 담은 error 객체를 사용합니다.

종료 코드Copy Anchor Link

모든 명령은 같은 소수의 종료 코드 집합을 사용합니다. 각 페이지는 그 명령이 반환할 수 있는 코드를 나열합니다.

사용법 오류는 절대 파일 시스템을 건드리지 않습니다. --json(또는 --format json)에서는 일반 사용법 텍스트 대신 "code": "cli.usage"가 담긴 오류 문서 하나를 출력하므로, 자동화가 잘못 입력한 플래그와 부분 쓰기를 구별할 수 있습니다.

슬래시 명령과 상위 수준의 CLI 개요는 CLI 개요 및 슬래시 명령 참조 페이지를 확인하세요.