Skip to content
baum
welcome to the docs

Hi, I’m Stumpy. Looking for something?

Search the docs, or start with the basics.

Know what's waiting on you.

The Inbox lists the pull requests that need you, and your own inboxes split them by repository, risk or kind of work.

The Inbox shows only what is waiting on you, grouped by what you do about it:

Group What’s in it
Needs your eyes Pull requests you’re asked to review.
Ready to merge Your own pull requests that can merge now.
Hand to an agent Your own pull requests with failing checks, requested changes or a conflict, or that are behind their base.

Select a pull request to see where it stands beside the list: what it waits on, what changed and baum’s review. From there you can merge, update the branch, re-run checks or start a fix, without opening the pull request. You can also merge every ready pull request at once, with one confirmation.

Not now? Press s to snooze a pull request until later, and u to undo. Everyone else’s pull requests are on the Pull requests page.

The Inbox, each of your inboxes and the Pull requests page each have a Filter. Pick filters from its menu, or type a query the way you would search GitHub.

Filter Example Keeps
repo repo=owner/name Pull requests in that repository. List several with commas.
org org=owner Every repository of an organisation or account.
author author=@me Pull requests by you, or by someone else.
assignee, review-requested review-requested=@me Pull requests assigned to you, or waiting for your review.
review review=approved Approved, changes_requested or none yet.
checks checks=failing passing, failing, running or none.
is is!=draft draft, mergeable, conflict, blocked, behind or bot.
risk risk>=4 A risk score from 1 to 5, or none yet.
base base=main Pull requests into that branch.
waiting waiting=merge In an inbox: what it waits for, review, merge or agent.

!=, - or NOT leaves pull requests out, a comma means either value, OR takes either side and parentheses group. Any other word is looked for in titles, repositories and numbers. Each page remembers its filter.

Add inboxes to split the Inbox your way: one per team, per project or per kind of work. They appear under Inbox in the sidebar, each with its own colour and count.

To add one, choose New inbox under Inbox in the sidebar. Start from Custom, or from a suggestion (Urgent, Work, Personal, Quick merges or For an agent), then:

  • give it a name and a colour;
  • set What it catches with the filter above; and
  • choose whether to Count it in the Inbox badge.

The preview shows what the inbox would hold right now. A new inbox is saved only when you save it; after that, changes save as you make them. When you change the filter of a saved inbox from its page, the change stays a draft until you save it into the inbox or as a new one.

To follow a project across a few repositories, create an inbox and set its filter to those repositories: repo= followed by each repository’s owner/name, separated by commas. Use one repository for a single-repository inbox, or org= with an organisation’s name for all of its repositories.

  • A pull request can be in several inboxes at once.
  • The main Inbox always shows everything waiting on you.
  • Its badge counts what is in no inbox, or in an inbox that counts in the badge, so a quiet inbox such as Personal doesn’t add to it.
  • You can have up to 20 inboxes. Reorder, edit or delete them in Manage inboxes.