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 명령이 사용하는 것과 동일한 구성 요소를 조합합니다 — 다시 구현하지 않습니다. --harness의 기본값은 all이고 --project의 기본값은 현재 디렉터리입니다.
동작
- 프로필 — 확인된 프로필 경로에 파일이 없으면,
quickstart는 시작용 프로필 생성을 제안하고(--yes, 비대화형 셸 또는--format json에서는 자동 생성), 개인화할 자리표시자 신원 필드를 명시합니다. - 미리 보기 + 확인 — 어떤 쓰기보다 먼저, 대상이 두 개의 머리글 아래에 나열됩니다(프로젝트 루트와 홈 디렉터리). 대화형 실행은 프로젝트 외부에 쓰기 전에 확인합니다.
--yes, 비대화형 셸,--format json은 묻지 않고 진행합니다. 거부하면 어떤 쓰기보다 먼저 중단됩니다. - 설치 — 하니스가 기본적으로 지원하지 않는 기능은 하니스당 하나의 그룹화된 노트로 요약됩니다(기능별 세부 정보는
--verbose를 전달하세요). 전체 집합은 항상--format json의 warnings 배열에 있습니다. - 다음 단계 — 터미널 출력은 후속 명령(
apothem verify …,apothem doctor)을 명시합니다.
옵션
| 옵션 | 설명 |
|---|---|
--harness NAME | 설치할 하니스 어댑터, 또는 레지스트리 전역 집합에는 all(기본값: 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은 각 안내 단계를 요약하는 단일 문서를 발생시킵니다:
{
"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
apothem quickstart --harness all --project . --yes
apothem quickstart --harness claude-code
apothem quickstart --json종료 코드
| 코드 | 의미 |
|---|---|
| 0 | 안내형 실행 완료 |
| 1 | 예상된 검증, 프로필, 하니스, 프로젝트 또는 어댑터 오류 |
| 2 | 적어도 한 번의 쓰기 후 부분 배치 구체화 |
함께 보기
- apothem install — 공유 프로필에서 하니스를 구체화합니다
- apothem verify — 설치가 활성 상태인지 확인합니다
- apothem doctor — 환경 및 설치 상태
- 시작하기 — 전체 설치 가이드