Documentation

Read the docs

Everything here is imported verbatim from the companion repository at build time, so it matches the code you are about to run. Pages are not rewritten for the web — they are the real documents.

InstallGet the binaryPrebuilt archives for macOS, Linux, and Windows, or a one-line go install.60 secondsRun the offline demoA throwaway store, a small Go repo, and a changeset. No account, token, or network.ReferenceRead the overviewInstallation, the GitHub quick start, connecting an agent, and the command table.

Start here

OverviewWhat Repo Companion is, how it is installed, and how an agent connects to it over MCP.README.md
Offline CLI demoA self-contained walkthrough of the whole workflow with no GitHub account, token, or network access.docs/DEMO_CLI.md

Guides

Setting up the storeRepository layout, branch protection, CODEOWNERS, the registry, and docs CI for the central store.docs/STORE.md
ArchitectureThe package map, data flow, and on-disk layout behind the CLI and the MCP server.docs/ARCHITECTURE.md

Reference

How it comparesRepo Companion next to AGENTS.md, Backstage, Confluence, and plain docs-as-code.docs/COMPARISON.md
FAQSetup, authentication, Windows, and design questions.docs/FAQ.md
TroubleshootingCommon errors and how to recover from them.docs/TROUBLESHOOTING.md

Synced from github.com/repocompanion/companion. See the contributing guide to fix something in the source.