$ squidy --docs

Framework 🦑 Squidy

A set of 10 Markdown documents that give your AI agent permanent context, rules and traceability — in any session, with any LLM.

How it works

boot ritual

# The agent runs this ritual before any action:

1. Read readme-agent.md → confirm initialization

2. Read doc/AGENT.md → agent instructions

3. Read doc/constitution.md → load rules

4. Read doc/oracle.md → load ADRs

5. Check doc/emergency.md → verify blockers

6. Check doc/kanban.md → pick a task

7. Read doc/session-context.md → current state

✓ Agent operational with full context

The 10 documents

Bootreadme-agent.md

Entry point. Instructs the agent to execute the initialization ritual before any action.

Agentdoc/AGENT.md

Specific instructions for Claude, Cursor and other agents. Loaded automatically in AGENT sessions.

Rulesdoc/constitution.md

Principles, prohibitions and Definition of Done. The agent consults it before each decision.

ADRsdoc/oracle.md

Architecture Decision Records. Documents the reasoning behind each relevant technical decision.

Tasksdoc/kanban.md

Task board with sequential IDs, acceptance criteria and progress traceability.

Blockersdoc/emergency.md

Critical blocker log. Prevents the agent from moving forward on known issues.

Sessiondoc/session-context.md

Current project state: what was done, what remains and what the next step is.

Standardsdoc/policies.md

Code conventions, naming patterns and style standards to follow.

Indexdoc/diary-index.md

Consolidated index of all development diary entries.

Diarydiary/YYYY-MM.md

Chronological record of decisions and actions. The agent writes what it did and why.

Available commands

squidy init

Initialize governance in the project (interactive interview)

squidy init --lang en-US

Generate documents in English

squidy init --dry-run

Preview files without creating them

squidy audit

Audit consistency of existing documents

squidy audit --fix

Automatically fix detected inconsistencies

squidy status

Display current project and document status

squidy doctor

Full diagnostic of installation and configuration