Skip to content
baum
welcome to the docs

Hi, I’m Stumpy. Looking for something?

Search the docs, or start with the basics.

Install baum.

baum runs as a desktop app on your computer. Download it, connect GitHub and your agents, and your pull requests show up ready to review.

Download the desktop app

Section titled “Download the desktop app”
Download for MacmacOS 12+, Apple silicon and IntelDownload for LinuxAppImage or .deb

On macOS, move baum to Applications before opening it. The macOS app and the AppImage update themselves; the .deb tells you when a new version is out.

Before you begin

Section titled “Before you begin”

You need:

  • a GitHub account with access to the repositories you want baum to follow;
  • Claude Code or Codex installed, signed in and working in your terminal; and
  • a local clone of those repositories, or baum can clone them for you.

Set up baum

Section titled “Set up baum”

The first time you open baum, three steps guide you through setup.

  1. Connect GitHub and pick repositories. Sign in with the code baum shows you, then pick the repositories to follow. baum finds their clones, or lets you choose a folder or clone them.
  2. Choose your agent. Pick Claude Code or Codex to write reviews, the model and effort to use, and which pull requests get a review automatically. Why baum asks for a model.
  3. Install the command and connect your agents. One click installs the baum command, and another connects each agent you use. baum sets up its plugin in Claude Code or Codex for you, so it can tell you about your sessions.

Codex only: after connecting, open Codex and approve baum’s hooks with /hooks. Codex doesn’t run new hooks until you do.

Stumpy’s tip

Agents load plugins when a session starts, so sessions that were already running before you connected baum don’t appear. Start a new session, or resume the old one with claude --resume or codex resume.

Use an existing GitHub token

Section titled “Use an existing GitHub token”

If you’d rather use a GitHub token you already have, add it to ~/.config/baum/config.toml:

github_token = "ghp_..."

Or export GH_TOKEN in your shell profile. If you use the GitHub CLI, you can reuse its token:

Terminal window
export GH_TOKEN="$(gh auth token)"

The token needs the repo and read:org scopes. Then choose Quit and stop background reviews from the tray menu and open baum again.

Change things later

Section titled “Change things later”

Everything from setup is in Settings: repositories, the review agent and model, the baum command and the agent hooks. Check this computer in Settings finds common problems and tells you how to fix them.