You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0707113
Browse filesBrowse the repository at this point in the historyBrowse files
Klaub runs the agent in a session of its own with a reviewer window next to it. Press `Ctrl+B` then `R` to open the reviewer, `Ctrl+B` then `A`to go back to the agent (lower case works too), and `Ctrl+B` then `d`to leave the session running in the background.`klaub session attach` brings it back. `Ctrl+B` then `Q` ends the session and the agent.
76
+
Klaub runs the agent in a session of its own with a reviewer window next to it. Press `Shift+→` to go to the reviewer and `Shift+←`to go back to the agent. `Ctrl+B` then `d`leaves the session running in the background, and`klaub session attach` brings it back. `Ctrl+B` then `Q` ends the session and the agent.
77
77
78
-
### Your first review in six keys
78
+
### Your first review in five keys
79
79
80
-
1. Open the queue with `klaub review`. The riskiest change is first.
80
+
1. Open the queue with `klaub review`. The riskiest change is first, and the code of the selected one is beside it.
81
81
2. Press `w` to see why it has that priority.
82
-
3. Press `Enter` to read the whole function. Press `v` to flip between the old and the new version.
83
-
4. Press `i` for the contract and `4` for the callers and the routes that reach the change.
84
-
5. Press `c` to comment on a line, and `r` to mark a unit as reviewed.
85
-
6. Press `F` to finish. Klaub saves the comments and prepares one short instruction for the agent.
82
+
3. Press `Enter` to focus the code, `v` to flip between the old and the new version and `[` and `]` to jump between the changed regions.
83
+
4. Press `i` for the contract and `K` for the symbol panel: its signature with the types, its documentation and its priority.
84
+
5. Press `r` to mark a unit as reviewed, and `2` or `3` to read the same change as a tree or as a list of files.
86
85
87
86
Press `?` at any time for the key list.
88
87
@@ -265,29 +264,22 @@ Every key below can be changed in `.klaub.toml` under `[keys]` ([configuration](
265
264
266
265
| Key | Mode |
267
266
| --- | --- |
268
-
|`1` or `F2`| Review, with the queue on the left |
269
-
|`2` or `F3`| Review, with the structure tree on the left: modules, files and symbols |
270
-
|`3`| Review, with the flat list of changed files on the left |
271
-
|`F4`| Review, with the code focused (`Enter` on a list gets there too) |
272
-
|`4`, `g` or `F5`| Impact: callers, entrypoints, callees |
273
-
|`5` or `F6`| Comments |
274
-
|`6`, `b` or `F8`| Context: brief and acceptance criteria |
275
-
|`7`, `t` or `F7`| Tests |
276
-
|`8` or `F10`| Follow-up: decide on the previous round's comments |
277
-
|`9`| Coverage |
278
-
|`0`, `f` or `F9`| Flow |
267
+
|`1` or `F2`| The queue on the left, ranked by risk |
268
+
|`2` or `F3`| The structure tree on the left: modules, files and symbols |
269
+
|`3`| The flat list of changed files on the left |
270
+
|`F4`| The code focused (`Enter` on a list gets there too) |
279
271
|`Tab`, `Shift+Tab`| Next and previous mode |
280
272
|`Esc`| Go back (from the code, to the list you came from) |
281
273
282
-
The review screen is a list on the left and the code of the selected unit on the right. The queue, the tree and the file list are three ways to fill the left side, and the code follows the cursor as you move in any of them. `K` shows or hides the panel beside the code: the symbol's signature with its types, the documentation comment it carries, the comments you wrote on it and the reasons for its priority.
274
+
The screen is a list on the left and the code of the selected unit on the right. The queue, the tree and the file list are three ways to fill the left side, and the code follows the cursor as you move in any of them. `K` shows or hides the panel beside the code: the symbol's signature with its types, the documentation comment it carries and the reasons for its priority.
283
275
284
276
### Moving and reading
285
277
286
278
| Key | Action |
287
279
| --- | --- |
288
280
|`j`, `k` or arrows | Move |
289
281
|`h`, `l`| Scroll sideways in code |
290
-
|`Enter`| Open the selected unit, symbol or step|
282
+
|`Enter`| Open the selected unit |
291
283
|`v`| Toggle old and new |
292
284
|`B` (hold) | Show the previous version while held, in supported terminals |
293
285
|`[`, `]`| Previous and next changed region |
@@ -303,15 +295,11 @@ The review screen is a list on the left and the code of the selected unit on the
303
295
304
296
| Key | Action |
305
297
| --- | --- |
306
-
|`c`| Comment on the selection (`V` selects several lines) |
307
298
|`w`| Why this priority, and silence a false positive |
308
299
|`r`| Mark reviewed or unmark |
309
300
|`m`, `,`| Bookmark a unit, jump to the next bookmark |
Copy file name to clipboardExpand all lines: docs/configuration.md
+5-11Lines changed: 5 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Every key has a default, so an empty file (or none) is valid. The schema lives i
31
31
|`ui.hold_to_peek`|`false`| Hold `B` (the `peek_previous` key) while reading code to see the previous version, and let go to come back. It needs a terminal that reports key releases (the kitty keyboard protocol: kitty, Ghostty, WezTerm, recent iTerm2 and foot). Where that is missing, which includes tmux, the key says so and `v` still toggles. While it is on, the terminal sends keys as escape codes except inside text fields, which keep ordinary input so compose and `AltGr` characters still type. |
32
32
|`integration.submit_mode`|`"manual"`| The only mode. Klaub never presses `Enter` in the agent. |
33
33
|`integration.paste_requires_confirmation`|`true`| Putting text in the agent's input always asks first. |
34
-
|`integration.tmux_prefix`|`"C-b"`| The prefix of the session chords. Moving between the agent and the reviewer needs no prefix: `Shift+←` goes to the agent and `Shift+→` to the reviewer. The rest are `Prefix+R`, `Prefix+A`, `Prefix+I`, `Prefix+C`, `Prefix+T`, `Prefix+B`, `Prefix+L`, `Prefix+Q` and `Prefix+?`. |
34
+
|`integration.tmux_prefix`|`"C-b"`| The prefix of the session chords. Moving between the agent and the reviewer needs no prefix: `Shift+←` goes to the agent and `Shift+→` to the reviewer. The rest are `Prefix+R`, `Prefix+A`, `Prefix+d`, `Prefix+Q` and `Prefix+?`. |
35
35
36
36
## `[keys]`
37
37
@@ -40,34 +40,28 @@ Moves a reader action to another single character. An action that is moved gives
The keys that only mean something inside some modes move the same way. A moved key answers to its new character in the modes it works in, and its old character stops acting there:
51
51
52
52
| Id | Default | Works in |
53
53
| --- | --- | --- |
54
-
|`down`, `up`|`j`, `k`| every list, scrolling view and the delivery list|
A mode-specific key may take a letter that another mode uses, but not one that is live in the same mode, and not one a global action already has. The footer and the help show the keys in use.
0 commit comments