v4.6 · Zero dependencies · Works with every AI tool

AI never forgets your project.

Drop .readmeAI in any project. The AI reads it first, every session — no re-explaining, no context drift, no wasted tokens.

$ curl -sSL https://raw.githubusercontent.com/Oscarr36/ReadMeAI/main/setup.sh | bash -s -- --all --detect
Works with  Claude Code · Cursor · Windsurf · GitHub Copilot · Cline · Roo Code · Aider · Continue · Zed · Junie · Antigravity CLI · Codex CLI · any AGENTS.md tool

Scroll

Day 2. Exactly where
you left off.

Without ReadMeAI: 8 messages to re-explain context. With it: one message and the AI resumes instantly.

session restart — day 2
✗ Without ReadMeAI
✓ With ReadMeAI

Built to eliminate friction.

01
🧭

Auto-read, zero prompts

AI reads the file before you type anything. No command, no reminder. Wired into the protocol at session start.

02
🔌

13+ AI tools, auto-wired

Setup detects Claude Code, Cursor, Windsurf, Copilot, Cline, Roo Code, Aider, Continue, Zed, Junie — and creates the right file for each.

03
🧠

Domain rules that stick

Non-obvious business rules, gotchas, architectural decisions — the things that cause bugs when unknown. Captured once, respected every session.

04
🔄

Autonomous sync

Git post-commit hook + Claude Code Stop hook update context automatically after every commit — in any editor, with zero commands.

05
📊

--health · --lint · --sync

Quality score [0-100], precise issue scanner, post-session context diff, and --compact to archive old entries. Full maintenance toolkit.

06
🚀

New project bootstrap

--new="your idea" injects the idea into .readmeAI. Your AI recommends the best stack, justifies it, and scaffolds the file structure.

07
✅

Code quality gate

Built-in checklist before every output: naming, nesting depth, forbidden patterns, no hardcoded values. Mandatory — AI can't skip it.

08
⚡

Lean by default

~300 lines active. Optional sections (Security, API, Testing, Performance) excluded until you need them. No dead weight in your context window.

09
🔍

Symbol index, no scanning

Key functions and classes listed with purpose. AI navigates your codebase without grepping every file — faster and more accurate.

Up and running in 30 seconds.

No accounts, no plugins, no lock-in.

01

Drop the file

Run the install command in your project root.

02

First setup

Tell your AI: "Detect my stack, fill what you can."

03

Every session

Just say "Continue where we left off."

One file.
Permanent context.

Works with every AI assistant. No plugins, no accounts, no lock-in. MIT License.

MIT LicenseZero dependenciesWorks offline13+ AI toolsv4.6