Config-only overlays for making existing codebases easier for AI coding agents to understand, change, and verify.
This repository is not an app starter. It contains files an agent can copy into an existing repository: agent instructions, local workflow rules, lightweight skills, and generic CI checks.
| Overlay | Use when | What it adds |
|---|---|---|
templates/general |
Every repository | AGENTS.md, Claude/Cursor safeguard rules, local agent skills |
templates/typescript |
TypeScript, JavaScript, Next.js, Vite, Bun, npm, pnpm, or Yarn projects | TypeScript agent notes and a generic CI workflow |
templates/go |
Go projects | Go agent notes and a generic CI workflow |
Use templates/general first, then add every detected language overlay. Mixed
Go + TypeScript repositories should receive both language overlays.
Copy the prompt in prompts/apply-agent-ready-overlays.md
into Claude Code, Codex, Cursor, or another coding agent while it is working in
the target repository.
The prompt tells the agent to:
- fetch this repository;
- auto-detect TypeScript and Go;
- copy only missing files;
- never overwrite, delete, or modify existing files without asking;
- verify copied files exist;
- summarize copied files and conflicts in chat only.
From a target repository, copy files from the selected overlays into the same relative paths:
# Always copy the general overlay first.
cp -R /path/to/agent-ready-codebase-templates/templates/general/. .
# Then copy each detected language overlay.
cp -R /path/to/agent-ready-codebase-templates/templates/typescript/. .
cp -R /path/to/agent-ready-codebase-templates/templates/go/. .Do not use the commands above blindly if the target repository already has files at those paths. Inspect conflicts first and merge intentionally.
- Config-only overlays, not runnable application code.
- One public repository with multiple overlay folders.
- Agent-first adoption path instead of an install script.
- Safe-by-default conflict behavior: do not overwrite.
- Chat-only application report; no generated report file.
- No branch management in the adoption prompt.
MIT. See LICENSE.