CLI 참조
quickstart
apothem quickstart 안내형 첫 실행 명령에 대한 CLI 참조.
안내형 첫 실행: 프로필이 존재하도록 보장하고, 쓰기를 미리 본 다음, 설치합니다.
개요
apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
[--yes] [--quiet|-q] [--verbose|-v]
[--format plain|json] [--json] [--no-color]quickstart는 새 운영자를 위한 단일 안내형 진입점입니다. 하나의 선형 흐름에서
다음을 수행합니다. (1) 공유 프로필이 존재하도록 보장합니다. 프로필을 찾지
못하면 개인화를 권하는 안내와 함께 스타터 프로필을 만듭니다. (2) 선택한
하니스가 쓸 구체적인 파일을 프로젝트 루트와 홈 디렉터리로 묶어 미리 보여
줍니다. (3) 확인을 요청합니다. (4) 묶이고 잡음이 제거된 기능 참고 출력과 함께
설치합니다. (5) 권장하는 다음 명령을 출력합니다.
이 명령은 install 명령이 사용하는 것과 같은 구성 요소를 조합하며, 그것들을
다시 구현하지 않습니다. --project의 기본값은 현재 디렉터리입니다.
--harness에는 기본값이 없습니다. 이 옵션을 생략하면 quickstart가 설치할
하니스를 묻기 때문에, 첫 실행은 하니스 하나의 구성을 씁니다. --harness all은
지원되는 모든 하니스를 설치하며, 항상 명시적인 선택입니다.
동작
- 하니스 —
--harness를 지정하지 않으면 대화형 실행이 지원되는 이름(그리고all)을 나열하고, 아무것도 쓰기 전에 하나를 고르라고 묻습니다. 물을 수 없는 실행(--yes,--format json, 또는 터미널 없음)은--harness옵션을 알려 주는 사용법 오류와 함께 중단되며, 아무것도 쓰지 않습니다. - 프로필 — 해석된 프로필 경로에 파일이 없으면
quickstart는 스타터 프로필 생성을 제안합니다(--yes, 비대화형 셸, 또는--format json에서는 자동으로 생성). 또한 개인화해야 할 자리표시자 신원 필드의 이름을 알려 줍니다. - 미리보기 + 확인 —
--harness all에서는 대상이 두 개의 제목(프로젝트 루트와 홈 디렉터리) 아래에 나열되며, 대화형 실행은 프로젝트 바깥에 쓰기 전에 확인을 받습니다. 하니스 하나를 이름으로 지정하면 미리보기나 프롬프트 없이 설치됩니다.--yes, 비대화형 셸,--format json은 프롬프트 없이 진행합니다.--harness all미리보기를 거부하면 설치 쓰기 전에 중단되며, 1단계에서 만든 스타터 프로필은 유지됩니다. - 설치 — 하니스가 네이티브로 지원하지 않는 기능은 하니스마다 하나의 묶인 참고로 요약됩니다(기능별 세부 정보는
--verbose를 지정하세요). 전체 목록은 항상--format json출력의 warnings 배열에 있습니다. - 다음 단계 — 터미널 출력은 후속 명령(
apothem verify …,apothem doctor)을 안내합니다.
옵션
| 옵션 | 설명 |
|---|---|
--harness NAME | 설치할 하니스 어댑터, 또는 레지스트리 전체 집합을 뜻하는 all. 기본값 없음: 대화형 실행은 묻고, 비대화형 실행은 반드시 이 옵션을 지정해야 합니다. |
--profile PATH | 공유 프로필 YAML 경로. 기본값은 ~/.config/apothem/profile.yaml. |
--project PATH | 프로젝트 범위 하니스의 프로젝트 루트. 기본값은 현재 디렉터리. |
--yes | 전체 안내형 시퀀스를 비대화형으로 실행합니다(모든 프롬프트를 건너뜀). |
--quiet, -q | 정보성 출력을 억제합니다. 오류만 출력됩니다. |
--verbose, -v | 묶인 참고 대신 투영되지 않은 각 기능의 근거를 출력합니다. |
--format plain|json | 출력 형식(기본값: plain). |
--json | --format json의 축약형. |
--no-color | 출력에서 ANSI 색상 코드를 비활성화합니다. |
-h, --help | 도움말을 표시하고 종료합니다. |
JSON 출력
--format json은 각 안내 단계를 요약하는 하나의 문서를 출력합니다.
{
"schema_version": 1,
"status": "success",
"command": "quickstart",
"profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
"steps": [
{"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
{"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
{"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
],
"recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}예제
apothem quickstart # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes # every harness, explicitly
apothem quickstart --harness claude-code --json종료 코드
| 코드 | 의미 |
|---|---|
| 0 | 안내형 실행 완료 |
| 1 | 예상된 검증, 프로필, 하니스, 프로젝트, 또는 어댑터 오류 |
| 2 | 적어도 한 번 쓴 뒤에 발생한 부분적인 일괄 머티리얼라이즈 |
| 64 | 사용법 오류: 알 수 없는 옵션이나 명령, 또는 누락되었거나 잘못된 옵션 값. --json에서는 이 오류가 코드 cli.usage를 담은 JSON 봉투로 출력됩니다. |
함께 보기
- apothem install — 공유 프로필로부터 하니스를 머티리얼라이즈
- apothem verify — 설치가 활성 상태인지 확인
- apothem doctor — 환경 및 설치 상태 점검
- 시작하기 — 전체 설치 가이드