On this page
9
Buddy is one binary that does two jobs: it reviews code, and it keeps
dependencies current. Everything below is the reference for driving both.
If you have not installed it yet, Getting Started is
the shortest path from nothing to a first review.
Start here
| Page | What it covers |
|---|
| What is Buddy? | The shape of the product, and what it replaces |
| Installation | Global install, project install, and the GitHub Action |
| Getting Started | From zero to a reviewed pull request |
| Usage | The day-to-day commands, in the order you meet them |
Command line
The CLI is the whole product — the GitHub Action is a thin wrapper around
these same commands.
AI
Buddy talks to a model you choose, with credentials that stay in your CI.
| Page | What it covers |
|---|
| Providers | Anthropic, OpenAI and the rest, and how keys resolve |
| Agent Runtime | What the agent may read and change |
| Headless Runs | buddy run, with schema-validated output |
Configuration
Reference
The behaviour behind each feature, once you have decided you want it.
Advanced
| Page | What it covers |
|---|
| Ecosystems | All eleven, and what each one supports |
| Monorepos | Every manifest at every depth, with no setting |
| Git Providers | GitHub, and what provider support means |
| Scheduling | Cron, presets and what runs when |
Migrating
API
For driving Buddy from your own code rather than the CLI.
Elsewhere
- Features — what each capability does, before you configure it
- Use Cases — the same product, arranged by the problem you have
- Comparisons — how Buddy differs from the tool you are on now
