Skip to content
baum
welcome to the docs

Hi, I’m Stumpy. Looking for something?

Search the docs, or start with the basics.

Your tiles. Your library.

Make a tile for a review in the session panel, save it to your tile library, and reuse it on later pull requests.

A review can open as tiles: one screen of cards that each show one part of the pull request. Turn this on in Settings → General (Tiles (preview)). Besides baum’s own tiles, you can make your own and keep them in your tile library, on your computer.

On a pull request’s review, open the session panel (a, or Ask) and say what you want to see, for example “show every new environment variable with its default”. The agent writes the tile for this pull request. Every tile you make reads Custom · and its title, so it is never mistaken for one of baum’s own, and each claim it makes links to the code it cites.

Ask the agent to save the tile. It writes a made-up sample for it, so your library never holds code from a real pull request, and shows you what it would save: the title, when to use it, the instructions given to the review agent when the tile is filled, and a preview. Nothing is saved until you press Save.

A saved tile is a tile type. Later reviews, in every repository, are offered your types where they apply: a type can name the files it is for, such as **/*.sql, and is offered only when the pull request changes one of them (a type that names none is offered for every pull request). Each review is offered up to six of your types, the ones you used most recently in that repository first, and the review fills each one it finds applies. A type pinned to a repository is filled in every review there, whatever the review finds. A type marked Not checked yet is not offered until its check passes. Its instructions are yours: nothing in a pull request can change them.

Settings → Tile library lists your types: where each came from (made in chat or imported), when to use it, the repositories it is pinned to and when a review last used it. Open one to:

  • see each of its samples drawn as the review would draw it, at each size;
  • Rename it (its title);
  • Edit in chat: open the session panel about this type and ask for a change, which you save as before;
  • Pin it to repositories: a pinned type is filled in every review of that repository;
  • restore an earlier version; every change is a new version;
  • Export it as a file;
  • Delete it, with Undo.

Reviews you already saved keep the tiles they were made with, whatever you change or delete later.

Export saves a type as a .baumtile.json file, with its made-up samples and no review content. Import in the Tile library reads one: you see its title, when it applies, its glance line, the instructions it gives the review agent (fill instructions and review checks) and a preview before anything is added. A name already in your library gets a number at the end. Invisible characters, such as text direction controls and zero-width characters, are removed from its text.

Importing also runs the render check on the type’s samples, so a type that doesn’t draw is refused. If the baum app isn’t open to draw them, the type is added marked Not checked yet; the check then runs the first time you preview it with the app open, and a type that passes loses the mark.

On Windows, the desktop app can’t draw custom tiles yet. Your library still works there; previews say they aren’t available.