# Repo Agent Kit

> Repo Agent Kit is a free, privacy-first web toolkit for making repository instructions concrete enough for coding agents to follow and humans to review.

Canonical site: https://repoagentkit.com

## What it does

Repo Agent Kit has ten primary product surfaces:

1. The generator turns a project name, purpose, stack, package manager, validation command, and selected guardrails into a repository instruction file. It supports AGENTS.md for Codex, CLAUDE.md for Claude Code, .cursor/rules/project.mdc for Cursor, and .github/copilot-instructions.md for GitHub Copilot.
2. The private checker evaluates an existing instruction file across eight categories: project context, setup commands, validation, architecture, coding conventions, safety, documentation, and definition of done. It returns a score, focused findings, and copyable repair blocks.
3. The template library provides complete AGENTS.md starting points for Next.js, FastAPI, React + Vite, Turborepo, Django, Go, Rust, and Laravel.
4. The examples lab contrasts vague instructions with operational versions for a small project, a production web app, and a monorepo.
5. The GitHub repository audit checks public repository evidence for AGENTS.md quality, setup context, tests, automation, and contribution guardrails, then creates a shareable report and optional README badge. The visitor's browser reads GitHub's public REST API directly without a token.
6. The Agent Readiness Benchmark publishes a deterministic, commit-pinned snapshot of 10 public development repositories with evidence links and a downloadable JSON dataset.
7. The Manifest to AGENTS.md generator reads package.json, pyproject.toml, go.mod, or Cargo.toml locally in the browser and produces a conservative first draft with detected commands and explicit verification notes.
8. The GitHub to AGENTS.md generator reads a small public evidence set directly from GitHub in the visitor's browser and creates a deterministic draft whose commands are labelled as exact scripts, lockfile-backed, or ecosystem defaults.
9. The instruction file converter preserves an existing Markdown instruction body while exporting the correct root file or repository path for AGENTS.md, Claude Code, Cursor, and GitHub Copilot. Cursor exports receive always-applied .mdc frontmatter; other formats remain plain Markdown.
10. The AI agent instruction file compatibility planner selects the smallest practical repository file set for Codex, Claude Code, Cursor, GitHub Copilot, Gemini CLI, and Windsurf. It uses AGENTS.md as the shared source, adds short bridge files only where support differs, and keeps path-scoping caveats visible.

The benchmark also publishes detailed root-AGENTS.md evidence reports for microsoft/vscode, openai/codex, rust-lang/rust, and vercel/next.js. Each report shows the pinned commit, deterministic matches, non-matches, file length, repository evidence, and a path to re-run the live audit.

## Recommended workflow

1. Start with a stack-specific template when one matches the repository. Otherwise use the generator.
2. Replace example commands and directory names with commands and paths verified in the repository.
3. Keep instructions observable: name exact commands, boundaries, prohibited actions, and completion evidence.
4. Run the result through the checker.
5. Store the file at the repository root, adding narrower nested files only when a subdirectory genuinely needs different rules.

## Product routes

- Generator: https://repoagentkit.com/
- Checker: https://repoagentkit.com/audit
- Templates: https://repoagentkit.com/templates
- Examples: https://repoagentkit.com/agents-md-examples
- GitHub repository audit: https://repoagentkit.com/github-repo-audit
- GitHub to AGENTS.md: https://repoagentkit.com/github-to-agents-md
- Agent Readiness Benchmark: https://repoagentkit.com/agent-readiness-benchmark
- Manifest to AGENTS.md: https://repoagentkit.com/manifest-to-agents-md
- Instruction file converter: https://repoagentkit.com/instruction-file-converter
- Instruction file compatibility planner: https://repoagentkit.com/ai-agent-instruction-files
- Benchmark JSON: https://repoagentkit.com/api/benchmark
- Public growth dashboard: https://repoagentkit.com/metrics

## Stack templates

- Next.js: https://repoagentkit.com/templates/nextjs
- FastAPI: https://repoagentkit.com/templates/fastapi
- React + Vite: https://repoagentkit.com/templates/react-vite
- Turborepo: https://repoagentkit.com/templates/turborepo
- Django: https://repoagentkit.com/templates/django
- Go: https://repoagentkit.com/templates/go
- Rust: https://repoagentkit.com/templates/rust
- Laravel: https://repoagentkit.com/templates/laravel

## Instruction design principles

Useful repository instructions are specific to the codebase and easy to verify. They normally cover:

- the package manager, locked install command, development command, and focused validation commands;
- the few files or directories an agent should inspect before editing;
- architecture and dependency boundaries that should remain intact;
- public interfaces, compatibility guarantees, and data or migration limits;
- security and privacy rules, including treatment of credentials and user-authored changes;
- accessibility and responsive behavior for interface work;
- the observable definition of done and what should be reported in the final handoff.

Avoid vague rules such as “write clean code,” “follow best practices,” or “run tests when possible” without naming the repository-specific behavior and evidence required.

## Privacy

The generator and checker run in the browser. Project details and audited file contents are not uploaded by those tools. First-party analytics use one random browser identifier per UTC day and aggregate path, product-action, and coarse acquisition-source counts. The application does not store IP addresses at the app layer, cookies, query strings, full referrer URLs, repository contents, or identifiers that persist across days. Do Not Track is respected. README badge image requests are not counted as users or product actions.

## Machine-readable resources

- Short index: https://repoagentkit.com/llms.txt
- Generator guide: https://repoagentkit.com/docs/generator.md
- Checker guide: https://repoagentkit.com/docs/checker.md
- Template guide: https://repoagentkit.com/docs/templates.md
- Examples guide: https://repoagentkit.com/docs/examples.md
- Metrics and privacy: https://repoagentkit.com/docs/metrics.md
- GitHub audit guide: https://repoagentkit.com/docs/github-audit.md
- GitHub generator guide: https://repoagentkit.com/docs/github-to-agents.md
- Benchmark guide: https://repoagentkit.com/docs/benchmark.md
- Manifest import guide: https://repoagentkit.com/docs/manifest-to-agents.md
- Instruction converter guide: https://repoagentkit.com/docs/instruction-file-converter.md
- Instruction compatibility guide: https://repoagentkit.com/docs/ai-agent-instruction-files.md
- XML sitemap: https://repoagentkit.com/sitemap.xml