$ squidy --docs

Framework 🦑 Squidy

Um conjunto de 10 documentos Markdown que dão ao seu agente de IA contexto, regras e rastreabilidade permanentes — em qualquer sessão, com qualquer LLM.

Como funciona

ritual de boot

# O agente executa esse ritual antes de qualquer ação:

1. Ler readme-agent.md → confirmar inicialização

2. Ler doc/AGENT.md → instruções do agente

3. Ler doc/constituicao.md → carregar regras

4. Ler doc/oraculo.md → carregar ADRs

5. Ver doc/emergencia.md → verificar bloqueios

6. Ver doc/kanban.md → escolher tarefa

7. Ler doc/contexto-sessao.md → estado atual

✓ Agente operacional com contexto completo

Os 10 documentos

Bootreadme-agent.md

Ponto de entrada. Instrui o agente a executar o ritual de inicialização antes de qualquer ação.

Agentedoc/AGENT.md

Instruções específicas para Claude, Cursor e outros agentes. Carregado automaticamente em sessões AGENT.

Regrasdoc/constituicao.md

Princípios, proibições e Definition of Done. O agente consulta antes de cada decisão.

ADRsdoc/oraculo.md

Architecture Decision Records. Documenta o porquê de cada decisão técnica relevante.

Tasksdoc/kanban.md

Board de tarefas com IDs sequenciais, critérios de aceite e rastreabilidade de progresso.

Bloqueiosdoc/emergencia.md

Registro de bloqueios críticos. Impede que o agente avance sobre problemas conhecidos.

Sessãodoc/contexto-sessao.md

Estado atual do projeto: o que foi feito, o que falta e qual o próximo passo.

Padrõesdoc/politicas.md

Convenções de código, padrões de nomenclatura e estilo a seguir.

Índicedoc/indice-diario.md

Índice consolidado de todas as entradas do diário de desenvolvimento.

Diáriodiario/YYYY-MM.md

Registro cronológico de decisões e ações. O agente escreve aqui o que fez e por quê.

Comandos disponíveis

squidy init

Inicializa a governança no projeto (entrevista interativa)

squidy init --lang en-US

Gera os documentos em inglês

squidy init --dry-run

Pré-visualiza os arquivos sem criá-los

squidy audit

Audita a consistência dos documentos existentes

squidy audit --fix

Corrige automaticamente inconsistências detectadas

squidy status

Exibe o status atual do projeto e dos documentos

squidy doctor

Diagnóstico completo da instalação e configuração