README
¶
baum
Keep up with what your coding agents build.
baum turns pull requests and agent sessions into clear reviews, a searchable decision log and a timeline of features. See what changed, understand the reasoning and focus on the calls that need your judgement.
Know what needs you
Find the pull requests waiting on you, the changes that need attention and the work that's ready to go. Risk scores, checks and approval status help you choose where to start, while the latest features show what the team is building.
Review the change with context
Get a clear explanation of what a pull request does, broken into sections ranked by how much attention they need. Follow the risks to their supporting evidence, inspect test results and see findings from your review agents in one place. Discuss the change and record your verdict alongside the review.
Find the “why” behind the code
Trace a change back to the agent sessions that produced it. Explore the prompts, tool activity and decisions behind the implementation, with context from Claude Code, Codex, Cursor and Entire sessions.
Search the decision log to find a past choice and the reasoning behind it, without digging through transcripts or asking someone to remember.
Follow features across pull requests
See related pull requests together as a feature, from work in progress to shipped. Catch up on the outcome, the decisions along the way and the sessions behind them. GitHub checks, comments and approvals stay connected.
Try baum
Start at usebaum.com. Access is currently limited; you can join the waitlist there.
License
MIT.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent defines the model backend interface and the types a run exchanges with it: the request, the result, the usage and the event log, plus the run budgets, the failure reasons, error classification and the environment a local CLI backend's child process receives.
|
Package agent defines the model backend interface and the types a run exchanges with it: the request, the result, the usage and the event log, plus the run budgets, the failure reasons, error classification and the environment a local CLI backend's child process receives. |
|
anthropic
Package anthropic is an agent.Backend that calls the Anthropic Messages API directly: a model call loop over a run directory with read-only file tools (Read, Glob, Grep) confined to that directory, whose final answer is the document the model submits through a StructuredOutput tool.
|
Package anthropic is an agent.Backend that calls the Anthropic Messages API directly: a model call loop over a run directory with read-only file tools (Read, Glob, Grep) confined to that directory, whose final answer is the document the model submits through a StructuredOutput tool. |
|
anthropic/anthropictest
Package anthropictest serves Messages API responses as the event streams the anthropic backend reads, for stub servers in tests.
|
Package anthropictest serves Messages API responses as the event streams the anthropic backend reads, for stub servers in tests. |
|
claude
Package claude runs the Claude Code CLI as an agent.Backend: a read-only model call loop over a directory whose final answer is a JSON document.
|
Package claude runs the Claude Code CLI as an agent.Backend: a read-only model call loop over a directory whose final answer is a JSON document. |
|
codex
Package codex runs the Codex CLI as an agent.Backend and derives the strict structured-output schema it passes to OpenAI.
|
Package codex runs the Codex CLI as an agent.Backend and derives the strict structured-output schema it passes to OpenAI. |
|
cursor
Package cursor runs the Cursor Agent CLI (cursor-agent) as an agent.Backend: a model call loop over a directory, in Cursor's read-only ask mode with its sandbox enabled, whose final message is a JSON document.
|
Package cursor runs the Cursor Agent CLI (cursor-agent) as an agent.Backend: a model call loop over a directory, in Cursor's read-only ask mode with its sandbox enabled, whose final message is a JSON document. |
|
prompt
Package prompt is the review prompt this module ships: the instructions the generate-and-repair loop (agent.Generator) gives a model backend.
|
Package prompt is the review prompt this module ships: the instructions the generate-and-repair loop (agent.Generator) gives a model backend. |
|
Description images: the rendered-image and markdown-upload walk of a pull request description, image identity and sniffing, the attachment listing of a bundle, and the archive that carries the images to a run.
|
Description images: the rendered-image and markdown-upload walk of a pull request description, image identity and sniffing, the attachment listing of a bundle, and the archive that carries the images to a run. |
|
cmd
|
|
|
baum
command
Command baum generates and views pull request review documents from local coding-agent sessions, the local git clone and GitHub, and carries the opt-in hosted service commands (login, setup, upload and the hooks).
|
Command baum generates and views pull request review documents from local coding-agent sessions, the local git clone and GitHub, and carries the opt-in hosted service commands (login, setup, upload and the hooks). |
|
Package githubapi holds GitHub API plumbing every host shares: the GraphQL transport that recognises primary and secondary rate limits, and the GraphQL scalars GitHub's schema adds.
|
Package githubapi holds GitHub API plumbing every host shares: the GraphQL transport that recognises primary and secondary rate limits, and the GraphQL scalars GitHub's schema adds. |
|
hosted
|
|
|
agenthooks
Package agenthooks holds the committed agent-hook vocabulary: which events each coding agent has, the exact command string a hook entry carries, and how to recognise one that is already ours.
|
Package agenthooks holds the committed agent-hook vocabulary: which events each coding agent has, the exact command string a hook entry carries, and how to recognise one that is already ours. |
|
apiclient
Package apiclient is the Go client for the hosted baum HTTP API, used by the hosted commands of the baum CLI.
|
Package apiclient is the Go client for the hosted baum HTTP API, used by the hosted commands of the baum CLI. |
|
baumcli
Package baumcli implements the hosted service commands of the baum CLI: login, logout, whoami, setup, upload and the hook dispatchers agents and Git call.
|
Package baumcli implements the hosted service commands of the baum CLI: login, logout, whoami, setup, upload and the hook dispatchers agents and Git call. |
|
traceupload
Package traceupload builds locally redacted archives of agent sessions.
|
Package traceupload builds locally redacted archives of agent sessions. |
|
userhooks
Package userhooks installs, updates and removes baum's hooks in the user-wide settings of Claude Code (~/.claude/settings.json) and Codex (~/.codex/hooks.json), so the agents run baum in every repository rather than only in those that commit its hooks.
|
Package userhooks installs, updates and removes baum's hooks in the user-wide settings of Claude Code (~/.claude/settings.json) and Codex (~/.codex/hooks.json), so the agents run baum in every repository rather than only in those that commit its hooks. |
|
internal
|
|
|
assemble
Package assemble builds the baum.review/1 generation bundle for one pull request on this machine, with no model call.
|
Package assemble builds the baum.review/1 generation bundle for one pull request on this machine, with no model call. |
|
assemble/assembletest
Package assembletest builds the synthetic inputs of bundle assembly tests: a git clone whose pull request exercises every kind of change, a fake GitHub that returns evidence for it, and a fake session source.
|
Package assembletest builds the synthetic inputs of bundle assembly tests: a git clone whose pull request exercises every kind of change, a fake GitHub that returns evidence for it, and a fake session source. |
|
automatic
Package automatic is the daemon's scheduler for reviews nobody asked for: it turns new pull request heads and new review requests, seen after automatic generation was enabled, into jobs on the existing queue.
|
Package automatic is the daemon's scheduler for reviews nobody asked for: it turns new pull request heads and new review requests, seen after automatic generation was enabled, into jobs on the existing queue. |
|
background
Package background keeps local GitHub metadata fresh without a generation queue, model backend, checkout export or hosted baum service.
|
Package background keeps local GitHub metadata fresh without a generation queue, model backend, checkout export or hosted baum service. |
|
cli
Package cli implements the baum command-line interface.
|
Package cli implements the baum command-line interface. |
|
config
Package config resolves baum settings from flags, the environment, the XDG config file and defaults, in that order of precedence.
|
Package config resolves baum settings from flags, the environment, the XDG config file and defaults, in that order of precedence. |
|
daemon
Package daemon runs baum's one long-lived local server per user, which the desktop app and coding-agent hooks share, and the client that finds, starts and stops it.
|
Package daemon runs baum's one long-lived local server per user, which the desktop app and coding-agent hooks share, and the client that finds, starts and stops it. |
|
discovery
Package discovery maintains a private, conditional GitHub inbox cache.
|
Package discovery maintains a private, conditional GitHub inbox cache. |
|
doctor
Package doctor reports why baum can or cannot find its tools, backend and GitHub token, with a fix for each problem.
|
Package doctor reports why baum can or cannot find its tools, backend and GitHub token, with a fix for each problem. |
|
filelock
Package filelock is an exclusive inter-process lock on a private file: an SQLite write transaction, which the operating system releases however the holding process exits, so a lock is never stale.
|
Package filelock is an exclusive inter-process lock on a private file: an SQLite write transaction, which the operating system releases however the holding process exits, so a lock is never stale. |
|
generate
Package generate is the pipeline behind "baum internal generate": it assembles the generation bundle for a pull request, unpacks the checkout into a private run directory, runs the shared generate-and-repair loop (agent.Generator) with a model backend, and finishes the document the way the hosted worker does: output redaction, secret rejection, derived fields, the generator block and a strict check of the stored form.
|
Package generate is the pipeline behind "baum internal generate": it assembles the generation bundle for a pull request, unpacks the checkout into a private run directory, runs the shared generate-and-repair loop (agent.Generator) with a model backend, and finishes the document the way the hosted worker does: output redaction, secret rejection, derived fields, the generator block and a strict check of the stored form. |
|
generate/generatetest
Package generatetest is a stub model backend for tests of "baum internal generate": it returns canned documents without calling a model, and records the run directories it was given.
|
Package generatetest is a stub model backend for tests of "baum internal generate": it returns canned documents without calling a model, and records the run directories it was given. |
|
github
Package github reads one pull request's metadata, commits, checks and conversation from GitHub's GraphQL API with the user's own token, and maps them onto the generation bundle the way every baum host does.
|
Package github reads one pull request's metadata, commits, checks and conversation from GitHub's GraphQL API with the user's own token, and maps them onto the generation bundle the way every baum host does. |
|
gitlocal
Package gitlocal reads a pull request out of a local clone with git, for a run on the user's machine.
|
Package gitlocal reads a pull request out of a local clone with git, for a run on the user's machine. |
|
goldentest
Package goldentest compares test output with committed golden files.
|
Package goldentest compares test output with committed golden files. |
|
hookevents
Package hookevents carries what coding-agent and Git hooks report to the user's baum daemon: the event a hook sends over the daemon's control socket, the private spool a hook falls back to when the daemon cannot take it, and the bounded local record the daemon keeps of every event it received, which code inside the daemon reads and subscribes to.
|
Package hookevents carries what coding-agent and Git hooks report to the user's baum daemon: the event a hook sends over the daemon's control socket, the private spool a hook falls back to when the daemon cannot take it, and the bounded local record the daemon keeps of every event it received, which code inside the daemon reads and subscribes to. |
|
hookrefresh
Package hookrefresh refreshes pull requests as soon as a hook reports they may have changed: a coding-agent session ending in a registered clone, or a push from one.
|
Package hookrefresh refreshes pull requests as soon as a hook reports they may have changed: a coding-agent session ending in a registered clone, or a push from one. |
|
jobs
Package jobs owns the persistent local generation queue.
|
Package jobs owns the persistent local generation queue. |
|
livesessions
Package livesessions tracks the coding-agent sessions running on this machine from the hook events the daemon records, and serves them to the local application so a pull request page and the inbox can show work in progress before any session file is complete.
|
Package livesessions tracks the coding-agent sessions running on this machine from the hook events the daemon records, and serves them to the local application so a pull request page and the inbox can show work in progress before any session file is complete. |
|
localapp
Package localapp embeds the local application.
|
Package localapp embeds the local application. |
|
locallink
Package locallink links the coding-agent sessions recorded on this machine to the commits of a pull request, using only this machine: the clone containing a directory supplies the commits and the home-directory and checkpoint stores supply the sessions.
|
Package locallink links the coding-agent sessions recorded on this machine to the commits of a pull request, using only this machine: the clone containing a directory supplies the commits and the home-directory and checkpoint stores supply the sessions. |
|
locallink/linktest
Package linktest builds the fixture the local linkage tests share: a real clone with a pull request's worth of commits, and a Claude Code store with one session that created the first of them.
|
Package linktest builds the fixture the local linkage tests share: a real clone with a pull request's worth of commits, and a Claude Code store with one session that created the first of them. |
|
openurl
Package openurl opens a URL in the user's default browser.
|
Package openurl opens a URL in the user's default browser. |
|
pricing
Package pricing turns the raw model strings adapters record into canonical models with known token rates.
|
Package pricing turns the raw model strings adapters record into canonical models with known token rates. |
|
privatefs
Package privatefs creates and checks files and directories only the current user may use: mode 0600/0700 and owned by the user on Unix, a protected current-user DACL on Windows.
|
Package privatefs creates and checks files and directories only the current user may use: mode 0600/0700 and owned by the user on Unix, a protected current-user DACL on Windows. |
|
prlink
Package prlink finds the open pull request that holds the work checked out in a local working tree, from the discovery cache.
|
Package prlink finds the open pull request that holds the work checked out in a local working tree, from the discovery cache. |
|
proc
Package proc makes cancelling a command stop its descendants where the platform allows.
|
Package proc makes cancelling a command stop its descendants where the platform allows. |
|
refresh
Package refresh updates the evidence of a saved local review without generation.
|
Package refresh updates the evidence of a saved local review without generation. |
|
repos
Package repos stores explicitly registered local clones and repository settings.
|
Package repos stores explicitly registered local clones and repository settings. |
|
reviewindex
Package reviewindex joins GitHub discovery with local immutable version stores.
|
Package reviewindex joins GitHub discovery with local immutable version stores. |
|
shellenv
Package shellenv reads the environment a user's login shell sets up, so a background process started from a desktop launcher (with a bare PATH) or from a coding agent (with the agent's environment) sees the same tools and settings as the user's terminal.
|
Package shellenv reads the environment a user's login shell sets up, so a background process started from a desktop launcher (with a bare PATH) or from a coding agent (with the agent's environment) sees the same tools and settings as the user's terminal. |
|
store
Package store keeps local review versions with immutable generation provenance.
|
Package store keeps local review versions with immutable generation provenance. |
|
textclean
Package textclean makes text captured from agents safe to store and print: tool output is captured verbatim from processes that emit binary, so it can carry NUL bytes and invalid UTF-8.
|
Package textclean makes text captured from agents safe to store and print: tool output is captured verbatim from processes that emit binary, so it can carry NUL bytes and invalid UTF-8. |
|
transcript
Package transcript shapes one session graph into the transcript the viewer's session card draws as a conversation: the session's human prompts in order, what each of them caused and the agent's text replies to it, and per prompt the agent activity (its messages, model calls and tool calls with their input and output) that the hosted service serves one prompt at a time and baum internal view serves in the same answer.
|
Package transcript shapes one session graph into the transcript the viewer's session card draws as a conversation: the session's human prompts in order, what each of them caused and the agent's text replies to it, and per prompt the agent activity (its messages, model calls and tool calls with their input and output) that the hosted service serves one prompt at a time and baum internal view serves in the same answer. |
|
uiserver
Package uiserver hosts the authenticated local application.
|
Package uiserver hosts the authenticated local application. |
|
viewer
Package viewer embeds the built standalone review viewer, the single-page app that the viewer package builds from its app directory.
|
Package viewer embeds the built standalone review viewer, the single-page app that the viewer package builds from its app directory. |
|
viewserver
Package viewserver serves the embedded review viewer and one review document on a loopback address.
|
Package viewserver serves the embedded review viewer and one review document on a loopback address. |
|
Package linkage is a pure, in-memory commit↔run matcher.
|
Package linkage is a pure, in-memory commit↔run matcher. |
|
gitevidence
Package gitevidence recognises git activity in text an agent captured — a command it ran, the output it got back.
|
Package gitevidence recognises git activity in text an agent captured — a command it ran, the output it got back. |
|
sessioncorrelate
Package sessioncorrelate derives the evidence the commit matcher needs from a session tree: repo-relative file paths, role-tagged commit refs, and the branches and working directories the tree was seen in.
|
Package sessioncorrelate derives the evidence the commit matcher needs from a session tree: repo-relative file paths, role-tagged commit refs, and the branches and working directories the tree was seen in. |
|
steps
Package steps holds one file per match step, each a pure linkage.Step.
|
Package steps holds one file per match step, each a pure linkage.Step. |
|
Package redact removes secrets and e-mail addresses from text before it is shown, stored or sent to a model provider.
|
Package redact removes secrets and e-mail addresses from text before it is shown, stored or sent to a model provider. |
|
Package review owns the review document model: the document types, the strict, lenient and stored views of the baum.review/1 schema, normalisation of model output, validation with located findings, derived fields, version history and model-free refresh, plus the tile catalogue.
|
Package review owns the review document model: the document types, the strict, lenient and stored views of the baum.review/1 schema, normalisation of model output, validation with located findings, derived fields, version history and model-free refresh, plus the tile catalogue. |
|
tilecatalogue
Package tilecatalogue holds the review tile catalogue: the kinds generation can offer and the selection guidance the model receives for each.
|
Package tilecatalogue holds the review tile catalogue: the kinds generation can offer and the selection guidance the model receives for each. |
|
Package schema embeds the baum.review/1 JSON Schema and compiles it for validation.
|
Package schema embeds the baum.review/1 JSON Schema and compiles it for validation. |
|
Package sessions finds the coding-agent sessions recorded for a repository on this machine and maps each into the normalised session.Graph.
|
Package sessions finds the coding-agent sessions recorded for a repository on this machine and maps each into the normalised session.Graph. |
|
claudetranscript
Package claudetranscript reads Claude Code transcripts as typed, classified lines.
|
Package claudetranscript reads Claude Code transcripts as typed, classified lines. |
|
collector/entire
Package entire finds Entire checkpoints in the user's own clone.
|
Package entire finds Entire checkpoints in the user's own clone. |
|
cursorsession
Package cursorsession maps Cursor's typed SQLite records into the shared session model.
|
Package cursorsession maps Cursor's typed SQLite records into the shared session model. |
|
cursortranscript
Package cursortranscript reads Cursor's global SQLite conversation store as typed records.
|
Package cursortranscript reads Cursor's global SQLite conversation store as typed records. |
|
entirecheckpoint
Package entirecheckpoint reads one Entire checkpoint tree without assigning session-model meaning to its records, and the checkpoint ids commits name in their Entire-Checkpoint trailers.
|
Package entirecheckpoint reads one Entire checkpoint tree without assigning session-model meaning to its records, and the checkpoint ids commits name in their Entire-Checkpoint trailers. |
|
entiresession
Package entiresession maps Entire checkpoint snapshots into shared session graphs, delegating native transcripts where a mapper exists.
|
Package entiresession maps Entire checkpoint snapshots into shared session graphs, delegating native transcripts where a mapper exists. |
|
prompttext
Package prompttext decides what part of a recorded user turn is a prompt somebody actually typed.
|
Package prompttext decides what part of a recorded user turn is a prompt somebody actually typed. |
|
session
Package session defines the vendor-agnostic session model.
|
Package session defines the vendor-agnostic session model. |
|
sourcepath
Package sourcepath handles filesystem paths recorded on a machine whose OS may differ from the process reading them.
|
Package sourcepath handles filesystem paths recorded on a machine whose OS may differ from the process reading them. |
|
sqliteread
Package sqliteread reads local SQLite stores that agents keep their session data in — today, Cursor's `state.vscdb` chat store.
|
Package sqliteread reads local SQLite stores that agents keep their session data in — today, Cursor's `state.vscdb` chat store. |
|
vendors
Package vendors holds the canonical agent slugs the platform stores and groups by.
|
Package vendors holds the canonical agent slugs the platform stores and groups by. |
|
validation
|
|
|
commitlabel
Package commitlabel relates captured validation calls to a reviewed revision.
|
Package commitlabel relates captured validation calls to a reviewed revision. |
Click to show internal directories.
Click to hide internal directories.