Drop .readmeAI in any project. The AI reads it first, every session — no re-explaining, no context drift, no wasted tokens.
Scroll
Without ReadMeAI: 8 messages to re-explain context. With it: one message and the AI resumes instantly.
AI reads the file before you type anything. No command, no reminder. Wired into the protocol at session start.
Setup detects Claude Code, Cursor, Windsurf, Copilot, Cline, Roo Code, Aider, Continue, Zed, Junie — and creates the right file for each.
Non-obvious business rules, gotchas, architectural decisions — the things that cause bugs when unknown. Captured once, respected every session.
Git post-commit hook + Claude Code Stop hook update context automatically after every commit — in any editor, with zero commands.
Quality score [0-100], precise issue scanner, post-session context diff, and --compact to archive old entries. Full maintenance toolkit.
--new="your idea" injects the idea into .readmeAI. Your AI recommends the best stack, justifies it, and scaffolds the file structure.
Built-in checklist before every output: naming, nesting depth, forbidden patterns, no hardcoded values. Mandatory — AI can't skip it.
~300 lines active. Optional sections (Security, API, Testing, Performance) excluded until you need them. No dead weight in your context window.
Key functions and classes listed with purpose. AI navigates your codebase without grepping every file — faster and more accurate.
No accounts, no plugins, no lock-in.
Run the install command in your project root.
Tell your AI: "Detect my stack, fill what you can."
Just say "Continue where we left off."
Works with every AI assistant. No plugins, no accounts, no lock-in. MIT License.