agentleFS
gabrielh-silvestregabrielh-silvestre/hexlog/docs/AGENTS.md

hexlog

AGENTS.md4 starsChanged 19 days agoMITView on GitHub

Parent context: ../AGENTS.md Generated: 2026-09-17 · Updated: 2026-10-17

The file

Files
AGENTS.md

docs

Parent context: ../AGENTS.md Generated: 2026-09-17 · Updated: 2026-10-17

Purpose

Documentação do hexlog: as diretrizes em directives/ (docs vivos de regras e ADRs 0007 a 0015, da 1.0), os guias de uso, instalação e dados, os estudos de apoio e a pesquisa de libs/padrões que fundamentou as decisões originais do 0.x.

Key Files

FileDescription
tetos-dominio-v1.mdDecisão N8 do PR #60: tetos de relations, Batch.key, RecordType, Gate.questions e aliases no domínio da v1, com o dado medido no 0.x (2026-09-30), quais números são precedente e quais são palpite, e como refazer a medição.
uso.mdCaminho de um projeto novo em 5 passos, exemplo completo das chamadas e tabela das 12 tools, com as convenções de nomes e target.
tools.mdReferência de entrada, saída e erros de cada uma das 12 tools; o mapa geral está em uso.md.
instalacao.mdRequisitos, instalação e atualização, instalação concorrente, versões antigas, verificação (--check) e como reverter.
setup-aceitacao.mdRoteiro manual de aceite do hexlog-setup num repositório de destino: pré-condições, passos com aprovação do dono, checklist por critério e como anexar a evidência.
migracao.mdArquivamento do dado 0.x (--archive-0x), releitura da trilha arquivada, volta ao 0.x e migração 0.x para 1.0.
dados.mdLayout de dados em <D>, erros e avisos, tetos do lock, destravamento manual, recuperação de PROCESS_CORRUPTED e lacunas de isolamento.
desenvolvimento.mdComandos de desenvolvimento, scripts de leitura (insights, export, timeline, seat-report) e como os testes se organizam.
feedback-loops.mdOnde o erro é pego antes do CI: o que o pre-commit, o commit-msg, o pré-PR do agente (flow-run, mark) e o hook de PR conferem, o que bloqueia, quanto leva e como rodar na mão.
telemetria.mdTelemetria opcional por OpenTelemetry: variáveis, atributos do span e das métricas, aviso telemetry-degraded, riscos residuais, privacidade, exemplo com OpenObserve, edição do env da entrada MCP e Collector local opcional.
friction-mining.mdComo a skill friction-mining minera transcripts do Claude Code atrás de atrito no uso de uma tool MCP, e como portá-la a outro projeto.
qualidade-ci.mdEstudo de plataformas de qualidade para CI/CD quando o repo for público: camadas agora/depois/nunca, esforço, custo e fonte de cada ferramenta, consultadas em 2026-09-17; o que está instalado vive no AGENTS.md da raiz e em directives/qualidade-e-testes.md.
qualidade-codigo.mdEstudo de qualidade de código e teste — TypeScript, ESLint, jest, property-based testing, mutação — consultado em 2026-09-17; o tier "Agora" e o Stryker (mutação dos unitários) já estão instalados, o resto é estudo.
ferramentas-similares.mdEstudo (nada adotado) de decisionlog.ai, mcp-server-decisions e ConPort comparados ao hexlog, com fontes primárias consultadas em 2026-09-17 e 5 ideias ranqueadas.
diagrama-c3-componentes.mdDiagrama C4 (nível C3, componentes) do servidor MCP em src/, gerado a partir do grafo de dependências internas descrito em src/AGENTS.md.

Subdirectories

DirectoryPurpose
directives/Docs vivos de regras (convenções, fronteiras, invariantes, qualidade e testes, documentação, instalação e hooks, fluxo, estratégia e cadeira do dono) e ADRs 0007 a 0015 (see directives/AGENTS.md)
pesquisa/Pesquisa de libs e padrões (17 frentes) que embasou as decisões do 0.x (see pesquisa/AGENTS.md)

Dependencies

Internal

Os ADRs de directives/ registram as decisões da arquitetura de src/ (domínio, serviços, ferramental), a camada sobre o OMC e a camada estratégica de premissas (ADR 0011 e directives/estrategia.md), a cadeira do dono que a emenda (ADR 0012 e directives/cadeira-do-dono.md), o setup em repositório de destino (ADR 0013), a cadeira do dono como pacote de dados desse setup (ADR 0014), a telemetria opcional por OpenTelemetry (ADR 0015), e o formato do log. A fonte da verdade do estado atual é o código.

Manual Notes

Diretrizes

  • documentacao.md: ADR só por emenda, como citar, pesquisa/ congelado e famílias de ID

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.