Skip to content
Apothem
Referência da CLI

status

Referência da CLI para o comando apothem status.

Relata o estado de instalação, de verificação e de desvio de cada harness registrado.

Sinopse

apothem status [--profile PATH] [--project PATH]
               [--quiet|-q] [--verbose|-v]
               [--format plain|json] [--json] [--no-color]

status é um comando de inspeção somente leitura. Ele percorre cada adaptador de harness registrado e relata três fatos por harness: se ele está instalado, se os seus alvos gerenciados passam na verificação e se a configuração instalada se desviou do perfil compartilhado. Ele não grava nada em disco.

Para cada harness, status relata:

ColunaSignificado
installedA configuração gerenciada do adaptador existe no seu caminho de destino.
verifiedOs alvos gerenciados do adaptador estão presentes e são válidos.
driftO veredito de fidelidade ao perfil (veja abaixo).

O valor de drift é um dos seguintes:

ValorSignificado
in-syncA configuração instalada carrega, textualmente, o perfil compartilhado recém-projetado.
driftO harness está instalado, mas o conteúdo de perfil projetado nele não corresponde mais ao perfil compartilhado atual. Execute apothem install novamente para refazer a projeção.
absentO harness não está instalado, portanto não há nada a comparar.
needs-projectUm harness com escopo de projeto foi relatado sem --project, então o seu alvo não pode ser resolvido. Passe --project PATH para inspecioná-lo.
unknownO perfil padrão não pôde ser carregado, então um harness instalado não tem nenhuma linha de base com a qual ser comparado. Corrija o perfil para restaurar o veredito de desvio.

O desvio é relatado, nunca tratado como erro: status sai com 0 mesmo quando um ou mais harnesses relatam drift. O desvio é um fato sobre a sua configuração, não uma falha do comando.

Se o perfil compartilhado padrão não puder ser carregado, o desvio é rebaixado para unknown nos harnesses instalados (os fatos de instalação e de verificação continuam sendo relatados), em vez de abortar a varredura. Um --profile explícito que não pode ser carregado é um erro do usuário e, em vez disso, aborta com um erro estruturado.

O rebaixamento é sempre relatado: status imprime um aviso que nomeia o perfil e a correção, e o envelope --json carrega uma entrada drift_baseline_unavailable correspondente em warnings. Isso importa mais quando nenhum harness está instalado — todas as linhas então mostram absent e não existe nenhuma célula unknown, de modo que o aviso é o único sinal de que a linha de base nunca foi carregada.

Opções

OpçãoDescrição
--profile PATHYAML do perfil compartilhado que seleciona a linha de base do desvio. Sem ele, é usado o perfil padrão (~/.config/apothem/profile.yaml).
--project PATHRaiz do projeto para os harnesses com escopo de projeto. Sem ela, os harnesses com escopo de projeto relatam needs-project.
--quiet, -qSuprime a saída informativa; apenas erros são emitidos.
--verbose, -vEmite saída de diagnóstico adicional.
--format plain|jsonFormato de saída (padrão: plain).
--jsonAbreviação de --format json.
--no-colorDesativa os códigos de cor ANSI na saída.
-h, --helpMostra a ajuda e sai.

Saída JSON

O envelope --json carrega uma linha de resultado por harness registrado. Cada linha carrega as chaves documentadas harness, installed, verified e drift. warnings fica vazio em uma varredura limpa; quando o perfil padrão não pôde ser carregado, ele carrega uma entrada drift_baseline_unavailable com path, code, reason e fix.

{
  "schema_version": 1,
  "status": "success",
  "command": "status",
  "action": "status",
  "harness": "all",
  "files_written": [],
  "results": [
    {
      "harness": "claude-code",
      "installed": true,
      "verified": true,
      "drift": "in-sync"
    },
    {
      "harness": "cursor",
      "installed": false,
      "verified": false,
      "drift": "needs-project"
    }
  ],
  "warnings": [],
  "error": null
}

Isolamento de falhas por adaptador: se um único adaptador lançar uma exceção ao relatar o seu status, a linha desse harness carrega outcome: "error" e uma message, os harnesses restantes continuam relatando normalmente, e o processo sai com o código 2.

Exemplos

apothem status
apothem status --project .
apothem status --json

Códigos de saída

CódigoSignificado
0Status relatado (o desvio é relatado, não é um erro)
1Erro de validação esperado (--profile inválido, ou um caminho de --project que não existe)
2Pelo menos um adaptador falhou ao relatar o seu status
64Erro de uso: uma opção ou um comando desconhecido, ou um valor de opção ausente ou inválido. Com --json, o erro é um envelope JSON com o código cli.usage.

Veja também

On this page