Getting started

If you haven't installed it yet, start with Installation.

Starting ReviewerCopy Anchor Link

Run reviewer from anywhere inside a repository:

reviewer

It opens where the Mac app would: your branch compared with the branch you compared it against last time, or your uncommitted work.

You can also tell it what to open:

reviewer ~/code/app                  # another repository
reviewer ~/code/app --against main   # a branch against main
reviewer --commit 4f2a9c1            # one commit
reviewer --pr 42                     # a GitHub pull request
reviewer ~/code/web ~/code/api       # two repositories side by side
reviewer -w platform                 # a saved workspace

The screenCopy Anchor Link

The terminal app is laid out like the Mac app:

• The sidebar on the left starts with the surface tabs, Browse, Review and Search. Under them are the branch chip, the comparison chip, and the files, with the commit box under the files while you review.
• The editor in the middle shows the diff or a file.
• The bottom pane holds History, Run and Usages. Press ⌘B or ⌃B to show or hide it.
• The bottom bar shows the keys that work where you are.

Press Tab to move between the sidebar, the editor and the bottom pane.

The command paletteCopy Anchor Link

Press ⌘K, ⌃K or : to open the command palette. Every action is in it, including the few with no key of their own. ⇧⌘O goes straight to file search, and ⇧⌘F to text search.

Finding your keysCopy Anchor Link

Press ? at any time to see the keys for where you are. The most-used ones are in Keys.

The app uses vim-style keys throughout: j and k move, g and G go to the top and bottom, and a number typed first repeats a move, so 10j moves down ten lines.

The mouseCopy Anchor Link

The mouse works everywhere. Click to select, double-click to open, and right-click for a menu on files, branches, commits and services. Drag the edges between panes to resize them.