Repo2agent

repo2agent

[English](./README.md) | [简体中文](./README.zh-CN.md)


Make any repo agent-ready in 5 seconds.

 

Generate `CLAUDE.md`, `AGENTS.md`, Copilot instructions, architecture docs, and an Agent Ready Score from a real repository scan.

`repo2agent` scans a codebase and generates the context files most teams still maintain by hand:

• CLAUDE.md
• AGENTS.md
• .github/copilot-instructions.md
• docs/ARCHITECTURE.md
• .ai/manifest.json
• .ai/score.json
• .ai/README_BADGE.md

This is a narrow tool for a fast-growing workflow: teams want Claude Code, Codex, Copilot, and other coding agents to understand a repo immediately without burning tokens or guessing project structure.

Why this is timely

• AI coding agents are a breakout developer workflow.
• MCP and agent tooling are now entering the GitHub mainstream.
• Most repositories still do not have clean, agent-friendly context files.
• The pain is obvious in one sentence, so the project is easy to demo and easy to share.

What it does

• Detects languages, frameworks, package manager, commands, test surfaces, and important paths.
• Generates a consistent agent context pack from a real repository scan.
• Calculates an agent-ready score and outputs a README badge.
• Works without an API key.
• Uses only built-in Node.js modules.

Quick start

git clone https://github.com/your-name/repo2agent.git
cd repo2agent
node ./src/cli.js init .

Print without writing:

node ./src/cli.js init . --print

Scan only:

node ./src/cli.js scan .

Score a repository:

node ./src/cli.js score .

Print badge markdown only:

node ./src/cli.js score . --badge

Write the badge into the root