Configuração¶
O Aegis Spec guarda toda a sua configuração e estado da análise dentro da pasta aegis/ na raiz do projeto. Você pode abrir e editar os arquivos quando quiser.
Estrutura da pasta aegis/¶
aegis/
├── config/
│ ├── state.json ← estado da análise entre sessões
│ ├── config.toml ← configuração do projeto
│ ├── config.user.toml ← preferências pessoais (não commitar)
│ ├── manifest.yaml ← metadados da instalação
│ └── files-manifest.json ← hashes SHA-256 para updates seguros
├── plan.md ← plano de exploração (você pode editar)
├── version ← versão instalada do Aegis Spec
├── runtime/
│ └── context/
│ ├── surface.json ← dados gerados pelo Scout
│ └── modules.json ← dados gerados pelo Archaeologist
├── specs/ ← specs geradas (sdd, adrs, openapi, …)
└── reports/ ← relatórios gerados (drift, gaps, …)
config.toml: configuração do projeto¶
Criado na instalação. Define as configurações compartilhadas com o time:
[project]
name = "meu-projeto"
language = "pt-br"
[agents]
installed = ["aegis", "scout", "archaeologist", "detective", "architect", "writer", "reviewer"]
[output]
folder = "aegis"
[engines]
active = ["claude-code"]
Você pode mudar o folder de saída se preferir um nome diferente de aegis.
config.user.toml: preferências pessoais¶
Para preferências que são suas e não devem ser commitadas:
Não commitar
Adicione config.user.toml ao .gitignore. Cada pessoa do time pode ter suas próprias preferências sem afetar os outros.
plan.md: plano de exploração¶
O Aegis Spec gera esse arquivo na primeira sessão, depois de conversar com você sobre o projeto. Ele lista as tarefas da análise em ordem.
Você pode editá-lo diretamente: reordenar tarefas, remover módulos que não quer analisar, adicionar notas. O Aegis Spec vai respeitar o que estiver aqui quando retomar a análise.
state.json: estado da análise¶
Mantido automaticamente pelo Aegis Spec. Registra a fase atual, quais agentes já rodaram e o progresso do Writer.
Você pode abrir para ver como está, mas não precisa editar manualmente. Se algo der errado e você precisar resetar uma fase específica, é aqui que você procuraria.
Modo de resposta (answer_mode)¶
Controla como o Reviewer levanta perguntas de validação para você:
| Modo | Comportamento |
|---|---|
chat (padrão) |
As perguntas aparecem no chat, uma a uma. Você responde na conversa. |
file |
O Reviewer gera um arquivo aegis/reports/questions.md com todas as perguntas. Você preenche e avisa quando terminar. |
O modo file é útil quando há muitas perguntas e você quer responder com calma, fora da sessão.
Nível de documentação (doc_level)¶
Define o volume de artefatos que cada agente vai gerar durante a análise. Não é configurado na instalação: o Aegis Spec pergunta no início da primeira análise, após o Scout mapear o projeto, para que você decida com informação real na mão.
| Valor | Quando usar | Artefatos gerados |
|---|---|---|
essencial |
Projetos simples, scripts, protótipos (padrão) | Análise de código, domínio, arquitetura (C4 contexto), specs SDD |
completo |
Projetos médios, equipes pequenas | Tudo do essencial + diagramas C4 completos, ERD, ADRs, OpenAPI, user stories, matrizes de rastreabilidade |
detalhado |
Sistemas enterprise, alta criticidade | Tudo do completo + flowcharts por função, ADRs expandidos, diagrama de deployment, revisão cruzada obrigatória |
A escolha fica salva em aegis/config/state.json no campo doc_level. Você pode editá-lo manualmente a qualquer momento para ajustar o nível no meio de uma análise.