quickstart

Primeira execução guiada: garante que exista um perfil, mostra uma prévia das gravações e depois instala.

SinopseCopy Anchor Link

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 único fluxo linear, ele: (1) garante que exista um perfil compartilhado — criando um perfil inicial com um lembrete para personalizá-lo, se nenhum for encontrado; (2) mostra uma prévia dos arquivos concretos que os harnesses selecionados vão gravar, agrupados por raiz do projeto versus o 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 próximos comandos recomendados.

Ele compõe os mesmos blocos de construção que o comando install usa — não os reimplementa. --project tem como padrão o diretório atual. --harness não tem padrão: quando é omitido, quickstart pergunta qual harness instalar, de modo que uma primeira execução grava a configuração de um único harness. --harness all instala todos os harnesses suportados e é sempre uma escolha explícita.

ComportamentoCopy Anchor Link

• Harness — sem --harness, uma execução interativa lista os nomes suportados (mais all) e pede um deles antes que qualquer coisa seja gravada. Uma execução que não pode perguntar — --yes, --format json ou sem terminal — para com um erro de uso que nomeia a opção --harness e não grava nada.
• Perfil — se o caminho de perfil resolvido não tiver arquivo, o 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 com marcadores de posição a personalizar.
• Prévia + confirmação — para --harness all, os destinos são listados sob dois títulos (raiz do projeto e seu diretório pessoal), e uma execução interativa pede confirmação antes de gravar fora do projeto. Um único harness nomeado é instalado sem prévia nem prompt. --yes, um shell não interativo e --format json prosseguem sem perguntar. Recusar a prévia de --harness all aborta a operação antes das gravações da instalação; um perfil inicial criado na etapa 1 é mantido.
• Instalação — as capacidades que um harness não suporta nativamente são resumidas em uma única nota agrupada por harness (passe --verbose para ver o detalhe por capacidade); o conjunto completo está sempre no array de warnings de --format json.
• Próximo passo — a saída do terminal nomeia os comandos seguintes (apothem verify …, apothem doctor).

OpçõesCopy Anchor Link

Saída JSONCopy Anchor Link

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

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

ExemplosCopy Anchor Link

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

Códigos de saídaCopy Anchor Link

Veja tambémCopy Anchor Link

• 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