quickstart

Referência da CLI para o comando guiado de primeira execução apothem quickstart.

Primeira execução guiada: garante que exista um perfil, previsualiza as escritas e então instala.

Sinopse

apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
                   [--yes] [--quiet|-q] [--verbose|-v]
                   [--format plain|json] [--json] [--no-color]

quickstart é o único ponto de entrada guiado para um novo operador. Em um fluxo linear, ele: (1) garante que exista um perfil compartilhado — criando um perfil inicial com um aviso de personalização se nenhum for encontrado; (2) previsualiza os arquivos concretos que os harness selecionados escreverão, agrupados por raiz do projeto versus seu diretório pessoal; (3) pede confirmação; (4) instala com a saída de notas de capacidade agrupada e sem ruído; e (5) imprime os comandos seguintes recomendados.

Ele compõe os mesmos blocos de construção que o comando install usa — não os reimplementa. --harness tem como padrão all e --project o diretório atual.

Comportamento

Perfil — se o caminho de perfil resolvido não tiver arquivo, quickstart oferece criar um perfil inicial (cria automaticamente com --yes, em um shell não interativo ou com --format json) e nomeia os campos de identidade de espaço reservado a personalizar.
Previsualizar + confirmar — antes de qualquer escrita, os destinos são listados sob dois cabeçalhos (raiz do projeto versus seu diretório pessoal); uma execução interativa confirma antes de escrever fora do projeto. --yes, um shell não interativo e --format json prosseguem sem perguntar. Recusar aborta antes de qualquer escrita.
Instalar — as capacidades que um harness não suporta nativamente são resumidas como uma nota agrupada por harness (passe --verbose para o detalhe por capacidade); o conjunto completo está sempre no arranjo warnings de --format json.
Próximo passo — a saída do terminal nomeia os comandos subsequentes (apothem verify …, apothem doctor).

Opções

Opção	Descrição
`--harness NAME`	Adaptador de harness a instalar, ou `all` para o conjunto de todo o registro (padrão: `all`).
`--profile PATH`	Caminho para o YAML do perfil compartilhado. O padrão é `~/.config/apothem/profile.yaml`.
`--project PATH`	Raiz do projeto para os harness com escopo de projeto. O padrão é o diretório atual.
`--yes`	Executa a sequência guiada completa de forma não interativa (pula cada prompt).
`--quiet`, `-q`	Suprime a saída informativa; apenas erros são emitidos.
`--verbose`, `-v`	Imprime a justificativa de cada capacidade não projetada em vez da nota agrupada.
`--format plain\|json`	Formato de saída (padrão: `plain`).
`--json`	Abreviação de `--format json`.
`--no-color`	Desativa os códigos de cor ANSI na saída.
`-h`, `--help`	Mostra a ajuda e sai.

Saída JSON

--format json emite um único documento que resume cada passo guiado:

{
  "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"]
}

Exemplos

apothem quickstart
apothem quickstart --harness all --project . --yes
apothem quickstart --harness claude-code
apothem quickstart --json

Códigos de saída

Código	Significado
0	Execução guiada concluída
1	Erro esperado de validação, perfil, harness, projeto ou adaptador
2	Materialização parcial do lote após ao menos uma escrita

Veja também

apothem install — materializa um harness a partir do perfil compartilhado
apothem verify — confirma que uma instalação está ativa
apothem doctor — saúde do ambiente e da instalação
Primeiros passos — guia de instalação completo