# Repo Companion

> Git-backed documentation and guidance for coding agents, reviewed through GitHub pull requests. Repo Companion keeps project docs, organization patterns, decisions, and standards in one central Git repository. A CLI and an MCP server let a coding agent ask "what guidance applies to this task?" and get ranked, cited answers, then propose documentation changes through the same reviewed pull request workflow humans use. Agents never merge.

Status: v0.2.0, pre-1.0. License: Apache-2.0. Platform: macOS, Linux, Windows.

## Install

- `go install github.com/repocompanion/companion/cmd/companion@latest` (Go 1.27.3+)
- Prebuilt archives: https://github.com/repocompanion/companion/releases/latest
- Build from source: `git clone https://github.com/repocompanion/companion.git && cd companion && make build`

## Connect an agent

MCP server over stdio, no port, no daemon:

- Claude Code: `claude mcp add --scope user companion -- companion mcp`
- Cursor (`~/.cursor/mcp.json`): `{"mcpServers":{"companion":{"command":"companion","args":["mcp"]}}}`
- Without MCP: `companion export agents-md --output AGENTS.md`, `companion export llms-txt`, `companion export context --format markdown`

## Docs

- [Overview](https://repocompanion.com/docs/overview/): installation, GitHub quick start, agent connection, command table, MCP tools, safety model.
- [Offline CLI demo](https://repocompanion.com/docs/demo/): a self-contained walkthrough with no GitHub account, token, or network access.
- [Store setup](https://repocompanion.com/docs/store-setup/): repository layout, branch protection, CODEOWNERS, registry, docs CI.
- [Architecture](https://repocompanion.com/docs/architecture/): packages, read path, write path, on-disk layout.
- [Comparison](https://repocompanion.com/docs/comparison/): versus AGENTS.md, Backstage, Confluence, and docs-as-code. Includes when it is not a good fit.
- [FAQ](https://repocompanion.com/docs/faq/): setup, authentication, Windows, design questions.
- [Troubleshooting](https://repocompanion.com/docs/troubleshooting/): common errors and recovery.
- [Install](https://repocompanion.com/install/): full install matrix and verification.

## Source

- Repository: https://github.com/repocompanion/companion
- Releases: https://github.com/repocompanion/companion/releases
- Changelog: https://github.com/repocompanion/companion/blob/main/CHANGELOG.md
- Security policy: https://github.com/repocompanion/companion/blob/main/SECURITY.md