@awebai/oats 0.67.1 → 0.68.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/oats.mjs +112 -16
- package/docs/capabilities.md +54 -5
- package/docs/capability-manifest.schema.json +4 -0
- package/docs/design/2026-10-22-module-upgrade.md +192 -0
- package/docs/design/README.md +4 -0
- package/docs/desktop-cli-api.md +248 -9
- package/docs/desktop.md +278 -61
- package/docs/first-team.md +5 -3
- package/docs/implementation.md +42 -3
- package/docs/integrations.md +16 -4
- package/docs/knowledge.md +44 -27
- package/docs/layers.md +2 -2
- package/docs/official-catalog.md +5 -5
- package/docs/packages.md +14 -14
- package/docs/release-notes/v0.68.0.md +504 -0
- package/docs/servers.md +6 -1
- package/docs/souls-and-instances.md +38 -3
- package/docs/tui.md +625 -223
- package/docs/upgrading.md +62 -6
- package/docs/workspaces.md +2 -2
- package/lib/capability-contract.mjs +6 -5
- package/lib/core.mjs +222 -38
- package/lib/instance-events.mjs +1 -1
- package/lib/instance-resolution.mjs +5 -5
- package/lib/instance-upgrade.mjs +1445 -0
- package/lib/materialize.mjs +225 -78
- package/lib/servers.mjs +11 -7
- package/lib/upgrade-state.mjs +101 -0
- package/lib/workspace.mjs +4 -1
- package/lib/worktree.mjs +103 -12
- package/package-catalog.json +5 -4
- package/package.json +1 -1
- package/packages/client/cli-adapter.mjs +15 -1
- package/packages/client/cli-locator.mjs +2 -2
- package/packages/client/deployment-panel.mjs +6 -2
- package/packages/client/keymap.mjs +89 -45
- package/packages/client/keys-file.mjs +9 -5
- package/packages/client/panel-views.mjs +16 -3
- package/packages/client/spawn-naming.mjs +7 -6
- package/packages/client/spawn-preview-cli.mjs +37 -1
- package/packages/client/spawn-preview-contract.mjs +35 -0
- package/packages/client/spawn-preview.mjs +35 -2
- package/packages/client/team-members.mjs +4 -1
- package/packages/client/workspace-step.mjs +25 -0
- package/packages/tui/README.md +5 -5
- package/packages/tui/lib/actions.mjs +51 -27
- package/packages/tui/lib/client.mjs +3 -2
- package/packages/tui/lib/config.mjs +4 -4
- package/packages/tui/lib/main.mjs +27 -13
- package/packages/tui/lib/model.mjs +132 -19
- package/packages/tui/lib/store.mjs +343 -68
- package/packages/tui/lib/term/keys.mjs +5 -3
- package/packages/tui/lib/term/kitty.mjs +28 -10
- package/packages/tui/lib/term/screen.mjs +15 -6
- package/packages/tui/lib/term/through.mjs +33 -28
- package/packages/tui/lib/views/frame.mjs +88 -109
- package/packages/tui/lib/views/help.mjs +56 -34
- package/packages/tui/lib/views/instances.mjs +4 -2
- package/packages/tui/lib/views/workspaces.mjs +55 -0
- package/skills/oats-getting-started/SKILL.md +92 -43
package/docs/tui.md
CHANGED
|
@@ -63,7 +63,7 @@ a path that is in no deployment: the `E_NO_DEPLOYMENT` line that names
|
|
|
63
63
|
where you are or from `--dir`, is added to this computer's list once, as the
|
|
64
64
|
TUI's (`oats deployments add <path> --via tui --json`), also when you had
|
|
65
65
|
removed it from the list. It is best effort: a failure opens nothing less,
|
|
66
|
-
and is said once, in the line under the
|
|
66
|
+
and is said once, in the line under the list of workspaces, in the kernel's words. When
|
|
67
67
|
it comes while the switcher, the help, a confirmation, the palette, the
|
|
68
68
|
spawn prompt, a detail or a terminal has the screen or the focus, it is said
|
|
69
69
|
once a view's list has the focus again, so no screen that covers the
|
|
@@ -95,7 +95,7 @@ runs.
|
|
|
95
95
|
## What it shows
|
|
96
96
|
|
|
97
97
|
```
|
|
98
|
-
|
|
98
|
+
acme-platform │ dev
|
|
99
99
|
│ soul dev
|
|
100
100
|
Instances 1 │ state running
|
|
101
101
|
> ● dev │ harness claude, claude-opus-5-5 (so…
|
|
@@ -121,24 +121,25 @@ a rule between them over every row. There is no header and no footer. From
|
|
|
121
121
|
80 columns the sidebar takes about half the width (36 to 60 columns, 30
|
|
122
122
|
while a terminal is open); under 80 columns it has the whole width.
|
|
123
123
|
|
|
124
|
-
- **The
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
- **Under the
|
|
124
|
+
- **[The list of workspaces](#the-list-of-workspaces)** is the sidebar's
|
|
125
|
+
first rows, five at most: every workspace this run can show, one line
|
|
126
|
+
each with its name, the open one in reverse video. Its machines are the
|
|
127
|
+
workspace's own pages' to say: the headings of its list of instances and
|
|
128
|
+
the detail's `machine` line. While [the switcher](#the-switcher) is
|
|
129
|
+
shown the list gives way to the title `workspaces`.
|
|
130
|
+
- **Under the list** stands what the view needs to say first, wrapped to
|
|
131
131
|
the sidebar's width: a deployment's state when it is not live, with
|
|
132
132
|
`since …` and its reason on rows of its own; the note of a view of one
|
|
133
133
|
deployment; and the line that says what happened after an open, an act or
|
|
134
|
-
a spawn. Then an empty row.
|
|
134
|
+
a spawn. Then an empty row. A line that goes at the next key and fits one
|
|
135
|
+
row (`No workspace above this one.`) stands in that empty row instead, so
|
|
136
|
+
nothing under it moves.
|
|
135
137
|
- **The views** follow as an accordion, always in this order: `Instances`,
|
|
136
138
|
`Souls`, `Capabilities`, each with its key dim at the right edge. The open
|
|
137
139
|
view's heading is bold and its list stands under it, with a rule between
|
|
138
140
|
it and the views before and after it. `1`, `2` and `3` open them in the
|
|
139
141
|
list, and [the leader](#the-leader) then `1`, `2` or `3` from anywhere;
|
|
140
|
-
|
|
141
|
-
keys. [The Souls view](#the-souls-view) lists the open workspace's souls,
|
|
142
|
+
[the palette](#the-palette) and the help name those keys. [The Souls view](#the-souls-view) lists the open workspace's souls,
|
|
142
143
|
and [the Capabilities view](#the-capabilities-view) its capabilities. A
|
|
143
144
|
workspace with no instances reads `No agents yet: n spawns one`, with the
|
|
144
145
|
key `spawn` has (`No agents yet.` when it has none).
|
|
@@ -149,14 +150,14 @@ while a terminal is open); under 80 columns it has the whole width.
|
|
|
149
150
|
`Ctrl+K palette`. In a view's list it names what `Enter` does now
|
|
150
151
|
(`open`, `focus terminal` on the row whose terminal is open, `detail`
|
|
151
152
|
in the Souls and Capabilities views), then `n spawn` where it spawns,
|
|
152
|
-
`w workspaces` (the
|
|
153
|
+
`w workspaces` ([the list of workspaces](#the-list-of-workspaces)) in the Instances view,
|
|
153
154
|
and `? help` and `q quit` last; with the detail's focus `Tab back`
|
|
154
155
|
comes before `Enter`. The other keys (the acts, `/`, `Tab`, `r`,
|
|
155
156
|
and a terminal's `z`, `c`, `[` and `]`) are not listed there:
|
|
156
|
-
the
|
|
157
|
+
the palette and the help name them. While the
|
|
157
158
|
terminal has the focus, in an overlay and in the filter field it names
|
|
158
|
-
the keys that work them. While the leader waits for its key the rows
|
|
159
|
-
|
|
159
|
+
the keys that work them. While the leader waits for its key the rows do
|
|
160
|
+
not change.
|
|
160
161
|
Everything flows from the top, so empty rows are at the bottom. On a
|
|
161
162
|
short screen the list keeps its rows first: the cheat sheet gives up rows
|
|
162
163
|
from its end, down to the leader alone, then the empty row under the
|
|
@@ -260,16 +261,17 @@ deployments on one machine) is one list, grouped as the Desktop groups it:
|
|
|
260
261
|
deployment, such as `garnet now reports workspace other.` for a machine
|
|
261
262
|
that reported another workspace before, or that a deployment's teams are
|
|
262
263
|
local only. It stands under the deployment's heading. In a view of one
|
|
263
|
-
deployment, which has no heading, it stands under the
|
|
264
|
+
deployment, which has no heading, it stands under the list of workspaces.
|
|
264
265
|
- **The detail has a `machine` line**, the machine the selected instance is
|
|
265
266
|
on. When that deployment is not live, the whole sentence that says why
|
|
266
267
|
follows it.
|
|
268
|
+
- **In a view of one deployment of another machine**, which has no heading,
|
|
269
|
+
the detail has the `machine` line too: nothing else names the machine.
|
|
267
270
|
|
|
268
|
-
**A view that holds no deployment of this machine**
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
is not live, is said under the title with the reason, as for a deployment
|
|
271
|
+
**A view that holds no deployment of this machine** names its machines in
|
|
272
|
+
its headings, or, with one machine, in the detail's `machine` line. The time
|
|
273
|
+
on the help's top row is then the time the machines' rows were read. A view of one machine has no heading, so its state, when it
|
|
274
|
+
is not live, is said under the list of workspaces with the reason, as for a deployment
|
|
273
275
|
of this machine. When no row of that machine is kept either, nothing is drawn
|
|
274
276
|
under the reason: no list and no detail.
|
|
275
277
|
|
|
@@ -332,7 +334,7 @@ last rows stay as they were; or they stay and are marked `stale`, with the
|
|
|
332
334
|
time of the last read that succeeded (a remote that could not be read
|
|
333
335
|
again); or the
|
|
334
336
|
deployment is `not observed` and no row is drawn. A state that is not live
|
|
335
|
-
is said in words under the
|
|
337
|
+
is said in words under the list of workspaces, with the reason on rows of its own. When
|
|
336
338
|
the kernel refused the read and no rows are kept, the reason says so and
|
|
337
339
|
quotes it: `OATS answered with an error (<code>). It says: <message>`. When
|
|
338
340
|
the last rows are kept as `stale`, the reason says so and then quotes the
|
|
@@ -358,7 +360,7 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
358
360
|
## Open an agent's terminal
|
|
359
361
|
|
|
360
362
|
```
|
|
361
|
-
|
|
363
|
+
acme-platform │[backend-lead 1]
|
|
362
364
|
│$ make docs
|
|
363
365
|
Instances 1 │Building the reference...
|
|
364
366
|
> ● backend-lead │
|
|
@@ -367,6 +369,10 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
367
369
|
Souls 2 │
|
|
368
370
|
Capabilities 3 │
|
|
369
371
|
──────────────────────────────│
|
|
372
|
+
Alt+K palette │
|
|
373
|
+
Alt+Shift+Up/Down agent │
|
|
374
|
+
Alt+W close │
|
|
375
|
+
Alt+Z zoom │
|
|
370
376
|
Ctrl+X commands │
|
|
371
377
|
Ctrl+X Esc the list │
|
|
372
378
|
Ctrl+X Ctrl+X types Ctrl+X │
|
|
@@ -374,8 +380,8 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
374
380
|
|
|
375
381
|
- **`Enter` on an instance that runs** opens its terminal on the right of
|
|
376
382
|
the sidebar, where the detail was, over every row. Its top row is the
|
|
377
|
-
[tab bar](#tabs), here one tab: the agent's name
|
|
378
|
-
` · <machine>` for one of another machine); under it is the
|
|
383
|
+
[tab bar](#tabs), here one tab: the agent's name and the tab's number in
|
|
384
|
+
brackets (no number on macOS; and ` · <machine>` for one of another machine); under it is the
|
|
379
385
|
agent's screen, as the agent draws it, in its own colours. While a
|
|
380
386
|
terminal is open the sidebar keeps 30 columns at most, also while the
|
|
381
387
|
detail stands in the terminal's place, and a name longer than its row is
|
|
@@ -385,25 +391,28 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
385
391
|
among them, but for **[the leader](#the-leader)** (`Ctrl+X`, unless
|
|
386
392
|
[`tui.json`](#change-the-keys-tuijson) names another), the
|
|
387
393
|
one key the TUI takes from the agent, and the [chords](#chords) (the
|
|
388
|
-
|
|
389
|
-
[
|
|
394
|
+
Alt ones by default, or the Ctrl+Alt or Ctrl+Shift ones when
|
|
395
|
+
[keys.json chooses them](#switch-family), while your terminal sends them). Under the kitty keyboard protocol every key reaches
|
|
390
396
|
the agent as the bytes it sends without it. The leader then `Esc` gives the
|
|
391
397
|
focus to the list; the leader twice types the leader into the agent; the
|
|
392
398
|
leader then another key does what that key does from anywhere. While the
|
|
393
399
|
terminal has the focus the cheat sheet names those three:
|
|
394
400
|
`Ctrl+X commands`, `Ctrl+X Esc the list`, `Ctrl+X Ctrl+X types Ctrl+X`.
|
|
395
|
-
While
|
|
396
|
-
|
|
397
|
-
`Alt+Shift+Up/Down agent`, `Alt+
|
|
398
|
-
more), `
|
|
399
|
-
|
|
400
|
-
|
|
401
|
+
While every chord of the family in force is read ([Chords](#chords)),
|
|
402
|
+
which in the Alt family is in every terminal, the chords come first:
|
|
403
|
+
`Alt+K palette`, `Alt+Shift+Up/Down agent`, `Alt+Left/Right tab` (with
|
|
404
|
+
two tabs or more), `Alt+W close`, `Alt+Z zoom`, then the leader's three.
|
|
405
|
+
In the Ctrl+Alt family they are `Ctrl+Alt+K`, `Alt+Shift+Left/Right`,
|
|
406
|
+
`Ctrl+Alt+W` and `Ctrl+Alt+Z`, and in the Ctrl+Shift family
|
|
407
|
+
`Ctrl+Shift+K`, `Ctrl+Shift+W` and `Ctrl+Shift+M`, which lead only while
|
|
408
|
+
the terminal confirms the kitty keyboard protocol. Without it the
|
|
409
|
+
leader's three lead, and the Alt+Shift arrows follow them.
|
|
401
410
|
On a short screen the sheet gives up rows from its end, and the leader's
|
|
402
411
|
`commands` last of all. A leader inside a bracketed paste is pasted, not
|
|
403
412
|
taken.
|
|
404
413
|
- **With the list focused** the terminal stays open, and the agent's screen
|
|
405
414
|
is still drawn as it changes. The cheat sheet names `Enter focus terminal`
|
|
406
|
-
on its row; the leader's
|
|
415
|
+
on its row; the help names the leader's `z` (zoom) and `w` (close terminal).
|
|
407
416
|
- `Enter` on the shown terminal's row gives it the focus again.
|
|
408
417
|
- `z` gives it the focus and the whole screen: the sidebar is hidden. The
|
|
409
418
|
leader then `Esc` brings the sidebar back beside it, and the leader then
|
|
@@ -424,10 +433,9 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
424
433
|
than 40 columns: with less room it has the whole screen too.
|
|
425
434
|
- **With the whole screen** (zoomed, or a narrow terminal) no cheat sheet is
|
|
426
435
|
drawn. The terminal's tab bar carries the keys at its right, dim:
|
|
427
|
-
`Ctrl+X commands Ctrl+X Esc the list`, after the chords
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
screen keeps every row under it.
|
|
436
|
+
`Ctrl+X commands Ctrl+X Esc the list`, after the chords while they
|
|
437
|
+
lead the cheat sheet (above), as many as fit, the same while the leader waits. The
|
|
438
|
+
agent's screen keeps every row under it.
|
|
431
439
|
- **A terminal also closes by itself** when its viewer ends, shown or
|
|
432
440
|
hidden ([which tab is shown then](#tabs)): the agent's
|
|
433
441
|
window ended, its session went away, or the link to its machine dropped.
|
|
@@ -438,7 +446,7 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
438
446
|
terminal without it when it has not come. A tmux built with libutempter
|
|
439
447
|
(Ubuntu's and Debian's are) can lose that status: while it waits,
|
|
440
448
|
`oats tui` has tmux look for it again once a second, so the terminal
|
|
441
|
-
still closes within a second or two with the line its status calls for. The instances are then read again at once, and the line under the
|
|
449
|
+
still closes within a second or two with the line its status calls for. The instances are then read again at once, and the line under the list of workspaces
|
|
442
450
|
says what happened: that it could not be opened, that the connection to
|
|
443
451
|
its machine ended, or that the viewer ended without saying why. What the
|
|
444
452
|
viewer printed on its error output stands under that line in quotation
|
|
@@ -467,7 +475,7 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
467
475
|
## Tabs
|
|
468
476
|
|
|
469
477
|
```
|
|
470
|
-
|
|
478
|
+
acme-platform │[backend-lead 1]│ docs-writer• 2 │ qa-runner 3
|
|
471
479
|
│$ make test
|
|
472
480
|
Instances 1 │ok 41 of 41
|
|
473
481
|
> ● backend-lead │
|
|
@@ -477,6 +485,11 @@ fit; the detail shows them whole. The TUI's own words end the same way:
|
|
|
477
485
|
Souls 2 │
|
|
478
486
|
Capabilities 3 │
|
|
479
487
|
──────────────────────────────│
|
|
488
|
+
Alt+K palette │
|
|
489
|
+
Alt+Shift+Up/Down agent │
|
|
490
|
+
Alt+Left/Right tab │
|
|
491
|
+
Alt+W close │
|
|
492
|
+
Alt+Z zoom │
|
|
480
493
|
Ctrl+X commands │
|
|
481
494
|
Ctrl+X Esc the list │
|
|
482
495
|
Ctrl+X Ctrl+X types Ctrl+X │
|
|
@@ -488,7 +501,7 @@ Each terminal open in the panel is a tab, and the panel holds up to four.
|
|
|
488
501
|
one tab or many, as a terminal's own tabs read: each tab's agent, in the
|
|
489
502
|
order the tabs were opened, a dim `│` (`|` in ASCII) between two tabs.
|
|
490
503
|
- **The shown tab** is the one whose screen the panel draws, the front
|
|
491
|
-
tab. It stands in brackets, `[backend-lead]`, a mark that needs no
|
|
504
|
+
tab. It stands in brackets, `[backend-lead 1]`, a mark that needs no
|
|
492
505
|
style, so it reads the same under `NO_COLOR` and in ASCII. Its name is
|
|
493
506
|
bold, and the whole tab is in reverse video while the terminal has the
|
|
494
507
|
focus.
|
|
@@ -497,7 +510,26 @@ Each terminal open in the panel is a tab, and the panel holds up to four.
|
|
|
497
510
|
name (`*` in ASCII), not dim; the mark goes when the tab is shown. A
|
|
498
511
|
hidden tab's screen is not read: only that its agent wrote.
|
|
499
512
|
- **An agent of another machine** reads `<name> · <machine>` inside its
|
|
500
|
-
tab, the machine dim (`-` for `·` in ASCII): `[billing-lead · garnet]`.
|
|
513
|
+
tab, the machine dim (`-` for `·` in ASCII): `[billing-lead · garnet 1]`.
|
|
514
|
+
- **Each tab ends with its number:** its position in its group's strip,
|
|
515
|
+
the N that `Alt+N` (`tab-N`) shows. It stands after the name, the
|
|
516
|
+
activity mark and the machine, one blank cell before the tab's closing
|
|
517
|
+
side (`[backend-lead 1]`, ` docs-writer• 2 `). It is dim, and dim in the
|
|
518
|
+
reverse video of the shown tab while its terminal has the focus. In a
|
|
519
|
+
[split](#splits) each group numbers its own tabs from 1. The first eight
|
|
520
|
+
tabs are numbered 1 to 8. In a strip of nine or more, the last tab
|
|
521
|
+
shows 9 (`tab-9` shows the last tab) and the others past the eighth
|
|
522
|
+
show none; with four tabs at most today, that is never reached. The
|
|
523
|
+
number is a position, not a key label: it is the same in every chord
|
|
524
|
+
family, and the same in ASCII. On macOS no tab has one: `⌥⌘1` to `⌥⌘9`,
|
|
525
|
+
the Desktop's keys for them, never reach a terminal, so no key would
|
|
526
|
+
reach the numbers.
|
|
527
|
+
- **The numbers go first, and all together.** They are drawn only while
|
|
528
|
+
every tab fits whole with them, every name and every machine.
|
|
529
|
+
Otherwise no tab shows a number, and the row is cut as below. A number
|
|
530
|
+
never takes a cell from a name. At 80 columns, with the sidebar beside
|
|
531
|
+
the panel, the numbers usually go at the third or fourth tab; at 120
|
|
532
|
+
all four fit.
|
|
501
533
|
- **A bar longer than its row is cut** in this order: the hidden tabs'
|
|
502
534
|
machines, then the hidden tabs' names, each to an equal share of what
|
|
503
535
|
the shown tab leaves, with `…` (`...` in ASCII), then the shown tab's
|
|
@@ -506,7 +538,7 @@ Each terminal open in the panel is a tab, and the panel holds up to four.
|
|
|
506
538
|
stays whole while the row can hold it, and is cut last.
|
|
507
539
|
- The TUI takes no mouse input: a tab is shown with the keys below.
|
|
508
540
|
- **Opening.** `Enter` on a row, an instance in
|
|
509
|
-
[the palette](#the-palette),
|
|
541
|
+
[the palette](#the-palette), `Alt+Shift+Up` or `Alt+Shift+Down`, and a
|
|
510
542
|
[spawn](#spawning-an-agent)'s new agent open a terminal the same way:
|
|
511
543
|
- an instance that has a tab: that tab is shown, with the focus in it;
|
|
512
544
|
- any other: a new tab, after the shown one, is shown with the focus in
|
|
@@ -515,17 +547,20 @@ Each terminal open in the panel is a tab, and the panel holds up to four.
|
|
|
515
547
|
machine is asked whether it can be opened, another open does nothing,
|
|
516
548
|
and neither does a key that shows another tab.
|
|
517
549
|
- **At four tabs nothing closes by itself.** The open does nothing, and
|
|
518
|
-
the line under the
|
|
550
|
+
the line under the list of workspaces says `4 terminals are open; close one with Ctrl+X w.`
|
|
519
551
|
(with your leader, when [`tui.json`](#change-the-keys-tuijson) names
|
|
520
552
|
another). A tab still starting, and an agent of another machine while
|
|
521
553
|
it is asked, hold a place among the four. An instance that cannot be
|
|
522
554
|
opened says why, as it does with no tab open.
|
|
523
555
|
- **Switching.** `[` and `]` in the Instances view, from the list or the
|
|
524
556
|
detail, show the tab before or after the shown one; the help names them,
|
|
525
|
-
and the leader's
|
|
526
|
-
open. The leader then
|
|
557
|
+
and the leader's own. The leader then
|
|
527
558
|
`Left` or `Right` does the same from any focus, and from another view
|
|
528
|
-
goes to the Instances view first
|
|
559
|
+
goes to the Instances view first, and so do the [chords](#chords)
|
|
560
|
+
`Alt+Left` and `Alt+Right` (`Alt+Shift+Left` and `Alt+Shift+Right` in the
|
|
561
|
+
Ctrl+Alt and Ctrl+Shift families). `Alt+1` to `Alt+8` show the focused
|
|
562
|
+
group's first to eighth tab, and `Alt+9` its last (`Ctrl+Alt+1` to
|
|
563
|
+
`Ctrl+Alt+9` in the other families).
|
|
529
564
|
- The bar does not wrap: on the first tab `[` does nothing, and on the
|
|
530
565
|
last `]`; the leader then `Left` or `Right` there leaves even the focus
|
|
531
566
|
where it was.
|
|
@@ -548,19 +583,44 @@ Each terminal open in the panel is a tab, and the panel holds up to four.
|
|
|
548
583
|
- Closing the last tab closes the panel: the right side is the detail
|
|
549
584
|
again, and the list has the focus.
|
|
550
585
|
- **A tab that closes by itself**, when its viewer ends, says so on the line
|
|
551
|
-
under the
|
|
586
|
+
under the list of workspaces in the words [above](#open-an-agents-terminal), for that
|
|
552
587
|
tab's agent (no line when it ended cleanly).
|
|
553
588
|
- The shown tab: the tab to its right is shown, else the one to its left,
|
|
554
589
|
and the list takes the focus.
|
|
555
590
|
- A hidden tab: the shown tab and the focus stay as they were.
|
|
556
591
|
- **Zoom** (`z`, or the leader then `z`) gives the shown tab the whole
|
|
557
592
|
screen. The tab bar stays its top row, and the other tabs stay open.
|
|
558
|
-
- **The tabs are the open workspace's
|
|
559
|
-
[the switcher](#the-switcher)
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
593
|
+
- **The tabs are the open workspace's, and it keeps them while the run
|
|
594
|
+
lasts.** Opening another workspace in [the switcher](#the-switcher)
|
|
595
|
+
closes their viewers; their agents keep running, and nothing of a hidden
|
|
596
|
+
workspace's terminals runs meanwhile. Coming back opens them again, one
|
|
597
|
+
at a time as an open goes, once the workspace's rows are read; a tab of
|
|
598
|
+
one of its deployments whose last read failed waits, with the tabs after
|
|
599
|
+
it, until that deployment is read again:
|
|
600
|
+
- the tabs in their order and their groups, the split, each group's
|
|
601
|
+
shown tab, and the focus (the terminal's, zoomed or not, or the list's)
|
|
602
|
+
as the workspace was left. The shown tab is the most recent for
|
|
603
|
+
[the palette](#the-palette).
|
|
604
|
+
- A tab whose instance is gone or cannot be opened now (retired,
|
|
605
|
+
stopped) is dropped, and nothing is said of it. A group the drops
|
|
606
|
+
leave with no tab goes, as when its last tab is closed; a group that
|
|
607
|
+
was empty when the workspace was left is empty again. A shown tab
|
|
608
|
+
dropped gives its place to the next, else the one before.
|
|
609
|
+
- Another machine's tab is asked first again, as an open is; when that
|
|
610
|
+
fails, the line says why and the tab is dropped. Suspending the TUI
|
|
611
|
+
while it is asked asks it again once the TUI is back.
|
|
612
|
+
- A key pressed while the tabs open again leaves the focus where it is:
|
|
613
|
+
the tabs still open, and the list keeps it. Opening an agent yourself
|
|
614
|
+
meanwhile stops it: the tabs not open yet are dropped. Opening another
|
|
615
|
+
workspace meanwhile closes what was opened, and keeps the rest for the
|
|
616
|
+
next time.
|
|
617
|
+
|
|
618
|
+
A workspace no longer being listed forgets them, open (its tabs close)
|
|
619
|
+
or not; one listed again later starts with none. A read that failed is
|
|
620
|
+
not the workspace gone: it forgets nothing.
|
|
621
|
+
Opening the same workspace again, with its deployment of this machine
|
|
622
|
+
now opened beside another machine's, keeps them as they are. Nothing is
|
|
623
|
+
kept after the run ends.
|
|
564
624
|
|
|
565
625
|
## Splits
|
|
566
626
|
|
|
@@ -590,7 +650,7 @@ tab and the marks of its hidden ones.
|
|
|
590
650
|
(left, or top). The second group starts empty and is the focused group.
|
|
591
651
|
- A split needs a tab open, and none starting.
|
|
592
652
|
- **There are at most two groups.** With two, the split keys do nothing,
|
|
593
|
-
and the line under the
|
|
653
|
+
and the line under the list of workspaces says `The panel has two groups already.`
|
|
594
654
|
- **Each group needs 40 columns side by side, and 8 rows one above the
|
|
595
655
|
other**, its tab bar counted. The panel beside the sidebar then needs 81
|
|
596
656
|
columns (a terminal of 112), or 17 rows. A split that would leave a
|
|
@@ -616,7 +676,7 @@ tab and the marks of its hidden ones.
|
|
|
616
676
|
- **Zoom** (`z`, or the leader then `z`) gives the focused group's shown
|
|
617
677
|
terminal the whole screen, and the same key brings the split back. With
|
|
618
678
|
the empty group focused it does nothing.
|
|
619
|
-
- **Opening.** `Enter`, the palette,
|
|
679
|
+
- **Opening.** `Enter`, the palette, `Alt+Shift+Up`/`Alt+Shift+Down` and a
|
|
620
680
|
spawn open as with one group:
|
|
621
681
|
- an instance that has a tab, in either group: that tab is shown in its
|
|
622
682
|
group, and that group takes the focus;
|
|
@@ -809,9 +869,95 @@ them, from the same code.
|
|
|
809
869
|
each with where it comes from; choosing one shows this view with it
|
|
810
870
|
selected.
|
|
811
871
|
|
|
872
|
+
## The list of workspaces
|
|
873
|
+
|
|
874
|
+
```
|
|
875
|
+
acme-platform │ dev
|
|
876
|
+
acme-billing ● │ soul dev
|
|
877
|
+
lfx │ state running
|
|
878
|
+
garnet │ harness claude, claude-opus-5-5 (so…
|
|
879
|
+
+2 │ work worktree, agents/dev
|
|
880
|
+
│ team eng
|
|
881
|
+
Instances 1 │ started 11:00
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
The sidebar's first rows list the workspaces this run can show, one row a
|
|
885
|
+
workspace, whatever machines it is on, in [the switcher](#the-switcher)'s
|
|
886
|
+
order: `lfx` is one row however many machines hold it, and a machine the
|
|
887
|
+
rules shared with the Desktop matched to no workspace is a row by its own
|
|
888
|
+
name, in the same flat list. A row is one line: the name. With one
|
|
889
|
+
workspace the list is its row.
|
|
890
|
+
|
|
891
|
+
- **Not in the list:** this computer's deployments that this run has not
|
|
892
|
+
opened (a workspace only they make), and the rows that cannot be opened
|
|
893
|
+
(missing, not a deployment, unreadable, a machine with nothing to open).
|
|
894
|
+
The switcher keeps them: `w` twice.
|
|
895
|
+
- **The open workspace's row** is in reverse video, and while the list has
|
|
896
|
+
the focus its name is underlined instead (the cursor has the reverse
|
|
897
|
+
video). Its state, when it is not live, is said under the list.
|
|
898
|
+
- **The dot**, `●` in yellow one cell after the name, says that an instance
|
|
899
|
+
of that workspace needs input, the claim the list of instances shows, the
|
|
900
|
+
open workspace's included. On a row in reverse video its cell is a gap in
|
|
901
|
+
the bar: the dot is on the normal background. With colour off
|
|
902
|
+
(`NO_COLOR`) or in ASCII it is `!`, and the help's Marks name it. It
|
|
903
|
+
comes from what this run observes alone, its reads of the deployments it
|
|
904
|
+
serves and of other machines: a workspace whose instances are not known
|
|
905
|
+
(never read, stale, not reached) has no dot, never a false one. The dot
|
|
906
|
+
never moves a row.
|
|
907
|
+
- **A long name** is cut with `…` (`...` in ASCII), the dot one cell after
|
|
908
|
+
what is drawn of it, as it is after a name drawn in `?` where the locale
|
|
909
|
+
is not UTF-8.
|
|
910
|
+
- **Five rows at most.** With more, four stand around the open row (around
|
|
911
|
+
the cursor's while the list has the focus), and `+N` says how many
|
|
912
|
+
workspaces are not shown, with the dot one cell after it when an instance
|
|
913
|
+
of one of them needs input (`+3 ●`; the help's Marks say so too). Under 80 columns or beside a terminal (30
|
|
914
|
+
columns) the names are cut as the list of instances cuts them.
|
|
915
|
+
|
|
916
|
+
**The keys:**
|
|
917
|
+
|
|
918
|
+
- **The leader then `Up` or `Down`**, or the [chords](#chords) `Alt+Up` and
|
|
919
|
+
`Alt+Down` (in the Alt family and on macOS; the Ctrl+Alt and Ctrl+Shift
|
|
920
|
+
families leave them to the programs, and the leader does it), opens the
|
|
921
|
+
workspace before or after the open one, as the list draws them. It does not wrap: at an end nothing
|
|
922
|
+
moves, and the line under the list says `No workspace above this one.` or
|
|
923
|
+
`No workspace below this one.` until the next key, of any kind (one typed
|
|
924
|
+
to an agent too), or a resize. The line stands in the empty row under the
|
|
925
|
+
list, so the list of instances does not move while it shows; only when
|
|
926
|
+
that list fills the sidebar, which then has no such row, does the line
|
|
927
|
+
take a row, the list giving up its last. With the list's focus (`w`) the
|
|
928
|
+
focus stays there, the cursor where it was. A workspace with a deployment of this
|
|
929
|
+
machine not opened yet (lfx, with `~/Work/lfx` on this computer's list)
|
|
930
|
+
opens it first, as the switcher's `Enter` does. What the workspace left
|
|
931
|
+
had open is kept for it, as for a switch from the
|
|
932
|
+
switcher ([Tabs](#tabs)), and from a terminal's focus the focus is kept
|
|
933
|
+
too.
|
|
934
|
+
With no workspace open (a run started outside a deployment, or the open
|
|
935
|
+
one gone), the switcher is shown, and the leader then `Down` opens the
|
|
936
|
+
first row the list would hold and `Up` its last; with no such row
|
|
937
|
+
nothing happens.
|
|
938
|
+
- **`w`**, the leader then `o`, and `Alt+O` (`Ctrl+Alt+O` or
|
|
939
|
+
`Ctrl+Shift+S` in the [other families](#switch-family)) give the list the focus, on the open workspace's row. The row
|
|
940
|
+
under the cursor carries `>` and the reverse video, and the open
|
|
941
|
+
workspace's name is underlined until `Enter` opens another; the list of
|
|
942
|
+
instances keeps its selection in reverse video, without its `>`. `Up`/`k`,
|
|
943
|
+
`Down`/`j`, `g`/`Home` and `G`/`End` move the cursor over the rows that
|
|
944
|
+
open; `Enter` opens its row and gives the list of instances the focus;
|
|
945
|
+
`Esc` gives that focus back with nothing opened; `w` again opens the
|
|
946
|
+
switcher, for what the list does not hold. Any other key gives the list
|
|
947
|
+
of instances the focus, then does what it does there. The cheat sheet
|
|
948
|
+
says `Enter open`, `Up/Down move`, `Esc back`, `w all workspaces`, with
|
|
949
|
+
the keys `tui.json` gives those actions; one with no key has no hint.
|
|
950
|
+
A row whose deployment an identity read places in a workspace (or takes
|
|
951
|
+
out of one) keeps the cursor: it moves to the row that now holds it.
|
|
952
|
+
- The list is no stop of `Tab`, and the TUI takes no mouse input.
|
|
953
|
+
|
|
812
954
|
## The switcher
|
|
813
955
|
|
|
814
|
-
`w`
|
|
956
|
+
`w` from [the list of workspaces](#the-list-of-workspaces)' focus (`w` twice
|
|
957
|
+
from the list of instances) opens the switcher: what this run can show, over
|
|
958
|
+
the main area, with what the list does not hold: each deployment's line,
|
|
959
|
+
this computer's deployments not opened, the rows that cannot be opened, the
|
|
960
|
+
filter, and Remove. With no workspace open, `w` opens it at once. The
|
|
815
961
|
sidebar's title says `workspaces` and no view is open; under 80 columns the
|
|
816
962
|
switcher covers the whole screen.
|
|
817
963
|
|
|
@@ -940,10 +1086,12 @@ A workspace this run has open has no Remove here.
|
|
|
940
1086
|
would make the file refused at the start. To use another key, give it to
|
|
941
1087
|
`remove` there, for example `{ "keys": { "remove": ["x"] } }`.
|
|
942
1088
|
|
|
943
|
-
**Each
|
|
944
|
-
where its list and its detail were scrolled, and what
|
|
945
|
-
found again when the
|
|
946
|
-
|
|
1089
|
+
**Each workspace keeps its place while the run lasts:** the selected
|
|
1090
|
+
instance, where its list and its detail were scrolled, the filter, and what
|
|
1091
|
+
was folded away are found again when the workspace is opened again, through
|
|
1092
|
+
any of its deployments. A filter still being typed in is kept as `Enter`
|
|
1093
|
+
keeps it. Another workspace starts with no filter, or with its own. Nothing
|
|
1094
|
+
is kept after the run ends.
|
|
947
1095
|
|
|
948
1096
|
**When the open workspace stops being listed** (it was a machine, and the
|
|
949
1097
|
kernel's answer stopped naming it), the switcher is shown with
|
|
@@ -975,7 +1123,7 @@ confirmation, which is needed only when the first retire's holder can't be
|
|
|
975
1123
|
read, since the kernel refuses a second retire while one runs. The
|
|
976
1124
|
palette offers the acts the selected instance offers now, and the leader's
|
|
977
1125
|
hint and the help name their keys. A key for an act
|
|
978
|
-
the instance does not offer opens nothing, and the line under the
|
|
1126
|
+
the instance does not offer opens nothing, and the line under the list of workspaces
|
|
979
1127
|
says why. The keys are yours to change in
|
|
980
1128
|
[`tui.json`](#change-the-keys-tuijson): the actions are `stop`, `retire`,
|
|
981
1129
|
`start` and `restart`.
|
|
@@ -1127,48 +1275,61 @@ The line after leaving says so and names `oats status` to see it.
|
|
|
1127
1275
|
The keys come in three layers:
|
|
1128
1276
|
|
|
1129
1277
|
1. **In the list:** plain keys, such as `n` to spawn, `w` for the switcher, `/` to filter ([In the list](#in-the-list)).
|
|
1130
|
-
2. **Anywhere, an agent's terminal included:** the [chords](#chords), `
|
|
1278
|
+
2. **Anywhere, an agent's terminal included:** the [chords](#chords), `Alt+K` and the rest by default, `Ctrl+Alt+K` or `Ctrl+Shift+K` and the rest [in the other families](#switch-family). Not plain `Ctrl+K`: that is the agent's, kill to the end of the line in Claude Code, Codex, pi and the shell.
|
|
1131
1279
|
3. **Always:** [the leader](#the-leader), `Ctrl+X` then a key, in every terminal.
|
|
1132
1280
|
|
|
1133
1281
|
### Every action's keys
|
|
1134
1282
|
|
|
1135
1283
|
The same keys in `oats tui` and in OATS Desktop. A column per way in: the
|
|
1136
1284
|
list's key (the Desktop's sidebar has the same, but `Ctrl+K`), the chord in
|
|
1137
|
-
each family on Linux and Windows, the
|
|
1138
|
-
`oats tui` has
|
|
1285
|
+
each family on Linux and Windows, the chord on macOS (the Desktop's;
|
|
1286
|
+
`oats tui` has those without ⌘, the ⌥ arrows: [Chords on
|
|
1287
|
+
macOS](#chords-on-macos)), and the key after the leader. `–` is no key of
|
|
1139
1288
|
that kind.
|
|
1140
1289
|
|
|
1141
|
-
| Action | In the list |
|
|
1142
|
-
|
|
1143
|
-
| the palette | `Ctrl+K` | `Ctrl+Alt+K` | `Ctrl+Shift+K` | `⌘K` | `k`, `Space` |
|
|
1144
|
-
| spawn an agent (the Desktop's Quick Open) | `n` | `Ctrl+Alt+P` | `Ctrl+Shift+P` | `⌘P` | `n` |
|
|
1145
|
-
| the switcher | `w` | `Ctrl+Alt+O` | `Ctrl+Shift+S` | `⌥⌘O` | `o` |
|
|
1146
|
-
|
|
|
1147
|
-
|
|
|
1148
|
-
|
|
|
1149
|
-
| split
|
|
1150
|
-
| the other
|
|
1151
|
-
| the
|
|
1152
|
-
| the
|
|
1153
|
-
| the
|
|
1154
|
-
| the
|
|
1155
|
-
|
|
|
1156
|
-
|
|
|
1157
|
-
|
|
|
1158
|
-
|
|
|
1159
|
-
|
|
|
1160
|
-
|
|
|
1161
|
-
| the
|
|
1162
|
-
| the
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
Ctrl+Shift+A
|
|
1170
|
-
|
|
1171
|
-
|
|
1290
|
+
| Action | In the list | Alt (default) | Ctrl+Alt | Ctrl+Shift | macOS | The leader then |
|
|
1291
|
+
|---|---|---|---|---|---|---|
|
|
1292
|
+
| the palette | `Ctrl+K` | `Alt+K` | `Ctrl+Alt+K` | `Ctrl+Shift+K` | `⌘K` | `k`, `Space` |
|
|
1293
|
+
| spawn an agent (the Desktop's Quick Open) | `n` | `Alt+P` | `Ctrl+Alt+P` | `Ctrl+Shift+P` | `⌘P` | `n` |
|
|
1294
|
+
| the list of workspaces (`w` there: the switcher) | `w` | `Alt+O` | `Ctrl+Alt+O` | `Ctrl+Shift+S` | `⌥⌘O` | `o` |
|
|
1295
|
+
| the workspace before, after | – | `Alt+Up`, `Alt+Down` | – | – | `⌥↑`, `⌥↓` | `Up`, `Down` |
|
|
1296
|
+
| zoom the shown terminal | `z` | `Alt+Z` | `Ctrl+Alt+Z` | `Ctrl+Shift+M` | `⌥⌘Z` | `z` |
|
|
1297
|
+
| close the shown terminal's tab | `c` | `Alt+W` | `Ctrl+Alt+W` | `Ctrl+Shift+W` | `⌘W` | `w` |
|
|
1298
|
+
| split side by side | `\|` | `Alt+E` | `Ctrl+Alt+E` | `Ctrl+Shift+E` | `⌘\` | `\|` |
|
|
1299
|
+
| split one above the other | `-` | `Alt+Shift+E` | `Ctrl+Alt+Shift+E` | `Ctrl+Shift+D` | `⌘⇧\` | `-` |
|
|
1300
|
+
| the next group | – | `Alt+Shift+Right` | `Ctrl+Alt+A` | `Ctrl+Alt+A` | `⌥⇧→` | `Tab` |
|
|
1301
|
+
| the previous group | – | `Alt+Shift+Left` | `Ctrl+Alt+Shift+A` | `Ctrl+Alt+Shift+A` | `⌥⇧←` | `Shift+Tab` |
|
|
1302
|
+
| the filter | `/` | `Alt+F` | `Ctrl+Alt+F` | `Ctrl+Alt+F` | `⌘F` | `/` |
|
|
1303
|
+
| the terminal of the instance before, after | – | `Alt+Shift+Up`, `Alt+Shift+Down` | `Alt+Shift+Up`, `Alt+Shift+Down` | `Alt+Shift+Up`, `Alt+Shift+Down` | `⌥⌘↑`, `⌥⌘↓` | – |
|
|
1304
|
+
| the tab before, after | `[`, `]` | `Alt+Left`, `Alt+Right` | `Alt+Shift+Left`, `Alt+Shift+Right` | `Alt+Shift+Left`, `Alt+Shift+Right` | `⌥←`, `⌥→` | `Left`, `Right` |
|
|
1305
|
+
| the first to eighth tab, the last | – | `Alt+1` to `Alt+9` | `Ctrl+Alt+1` to `Ctrl+Alt+9` | `Ctrl+Alt+1` to `Ctrl+Alt+9` | `⌥⌘1` to `⌥⌘9` | – |
|
|
1306
|
+
| an instance's name and colour (OATS Desktop only) | – | `Alt+R` | `Ctrl+Alt+R` | `Ctrl+Alt+R` | `⌥⌘R` | – |
|
|
1307
|
+
| move the tab to the other group | – | – | – | – | – | `m` |
|
|
1308
|
+
| close the empty group | – | – | – | – | – | `x` |
|
|
1309
|
+
| stop, restart, start, retire | `X`, `R`, `S`, `D` | – | – | – | – | `X`, `R`, `S`, `D` |
|
|
1310
|
+
| spawn another of the soul | `N` | – | – | – | – | `N` |
|
|
1311
|
+
| the Instances, Souls, Capabilities views | `1`, `2`, `3` | – | – | – | – | `1`, `2`, `3` |
|
|
1312
|
+
| the help | `?` | – | – | – | – | `?` |
|
|
1313
|
+
| the list | `Esc` | – | – | – | – | `Esc` |
|
|
1314
|
+
|
|
1315
|
+
The Ctrl+Shift family moves seven of the Ctrl+Alt family's chords to
|
|
1316
|
+
Ctrl+Shift. The others keep their Ctrl+Alt key: Ctrl+Shift with an arrow
|
|
1317
|
+
selects text in inputs and editors, Ctrl+Shift with a digit is a shifted
|
|
1318
|
+
symbol on most layouts, and Ctrl+Shift+A and Ctrl+Shift+F are taken by
|
|
1319
|
+
terminals (kitty, Ghostty, and for F Alacritty and GNOME Terminal too) and
|
|
1320
|
+
by agents (Codex's Ctrl+Shift+A, pi's Ctrl+Shift+F). The workspace moves
|
|
1321
|
+
and the previous group are new in this version. The workspace moves are
|
|
1322
|
+
`Alt+Up` and `Alt+Down` in the Alt family alone: the Ctrl+Alt and
|
|
1323
|
+
Ctrl+Shift families are for whoever needs Alt in their programs, so they
|
|
1324
|
+
leave those keys to them, and the leader's `Up` and `Down` move between
|
|
1325
|
+
workspaces there. The previous group is `Alt+Shift+Left` in the Alt
|
|
1326
|
+
family, beside `Alt+Shift+Right` for the next, and `Ctrl+Alt+Shift+A` in
|
|
1327
|
+
the other two, beside `Ctrl+Alt+A`. On macOS the moves between tabs,
|
|
1328
|
+
groups and workspaces are ⌥ with an arrow, in both clients; the letters
|
|
1329
|
+
and digits keep ⌘, since ⌥ with one types a character.
|
|
1330
|
+
`Alt+R` (`Ctrl+Alt+R` in the other families) is the Desktop's alone:
|
|
1331
|
+
`oats tui` has no such action and binds no key for it. The list's own keys for moving and reading are in
|
|
1332
|
+
[In the list](#in-the-list). The tables come from
|
|
1172
1333
|
`packages/client/keymap.mjs` (`CHORDS`, `PLAIN_KEYS`, `LEADER_TABLE`), which
|
|
1173
1334
|
both clients read.
|
|
1174
1335
|
|
|
@@ -1176,70 +1337,182 @@ both clients read.
|
|
|
1176
1337
|
|
|
1177
1338
|
For `oats tui`, on Linux and Windows. `✓` is a family whose chords reach
|
|
1178
1339
|
`oats tui` in that terminal, `✗` one whose chords do not, with the reason.
|
|
1179
|
-
The leader works in all of them. In OATS Desktop
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
|
1185
|
-
|
|
1186
|
-
|
|
|
1187
|
-
|
|
|
1188
|
-
|
|
|
1189
|
-
|
|
|
1190
|
-
|
|
|
1191
|
-
|
|
1192
|
-
|
|
1340
|
+
The leader works in all of them. In OATS Desktop every family works. The
|
|
1341
|
+
Alt family needs no kitty keyboard protocol: `Alt` with a letter or a digit
|
|
1342
|
+
is `Esc` and the key, and the Alt arrows have sequences of their own, in
|
|
1343
|
+
every terminal below.
|
|
1344
|
+
|
|
1345
|
+
| Terminal | Alt (default) | Ctrl+Alt | Ctrl+Shift |
|
|
1346
|
+
|---|---|---|---|
|
|
1347
|
+
| foot | ✓ | ✓ | ✓ |
|
|
1348
|
+
| Alacritty | ✓ | ✓ | ✓ |
|
|
1349
|
+
| Ghostty | ✓, but on Linux `Alt+1` to `8` are its tabs and `Alt+9` its last, when the tab changes | ✓ | ✗ Ghostty closes its own tab on Ctrl+Shift+W, taking oats tui with it |
|
|
1350
|
+
| kitty | ✓ | ✓ | ✗ kitty takes Ctrl+Shift+K, P, S, W and E for itself; W closes its window, `oats tui` with it |
|
|
1351
|
+
| WezTerm | ✓ | ✓ with `enable_kitty_keyboard`; without it only the Alt+Shift arrows | ✗ WezTerm takes Ctrl+Shift+K, P, M and W for itself: clear the scrollback, its command palette, hide the window, close the tab |
|
|
1352
|
+
| GNOME Terminal | ✓, but with two tabs or more `Alt+1` to `9` are its tabs | ✗ no kitty keyboard protocol (VTE has none): only the Alt+Shift arrows arrive | ✗ no kitty keyboard protocol: a Ctrl+Shift letter reaches a program as the Ctrl letter |
|
|
1353
|
+
| Konsole | ✓, but with two tabs or more `Alt+1` to `9` are its tabs | ✓ since 26.08 | ✗ Konsole takes all seven for itself; Ctrl+Shift+W closes the tab |
|
|
1354
|
+
| Windows Terminal | ✓, but with split panes the Alt arrows move between them and the Alt+Shift arrows resize them | ✓, but `Ctrl+Alt+1` to `9` are its tabs, and the Alt+Shift arrows resize its split panes | ✗ Windows Terminal takes Ctrl+Shift+K, P, M, W and D for itself; W closes the pane |
|
|
1355
|
+
|
|
1356
|
+
Where a terminal takes `Alt` with a digit, the leader then `Left` or
|
|
1357
|
+
`Right` and `Alt+Left`, `Alt+Right` still go from tab to tab, or choose
|
|
1358
|
+
Ctrl+Alt. On macOS `oats tui` has the ⌥ arrows alone, and which macOS
|
|
1359
|
+
terminals send them is in [Chords on macOS](#chords-on-macos); a macOS
|
|
1360
|
+
terminal sends Option with a letter as a character (`Option+K` is `˚`)
|
|
1361
|
+
unless it is set to send Option as Meta (Terminal.app's "Use Option as
|
|
1362
|
+
Meta key", iTerm2's Option key "Esc+"), and then the program in the
|
|
1363
|
+
terminal gets it. Each terminal's defaults at the release
|
|
1193
1364
|
[the full matrix](#which-terminals-let-the-chords-through) names.
|
|
1194
1365
|
|
|
1195
|
-
|
|
1366
|
+
<a id="switch-to-ctrlshift"></a>
|
|
1196
1367
|
|
|
1197
|
-
|
|
1198
|
-
|
|
1368
|
+
### Switch family
|
|
1369
|
+
|
|
1370
|
+
On Linux and Windows. macOS has no choice: the Desktop keeps its ⌘ chords
|
|
1371
|
+
and its ⌥ arrows there, and `oats tui` the ⌥ arrows ([Chords on
|
|
1372
|
+
macOS](#chords-on-macos)) and the leader.
|
|
1199
1373
|
|
|
1200
1374
|
- **In OATS Desktop:** the Shortcuts page (`Ctrl+,`), at its top, **Shortcut
|
|
1201
|
-
family, shared with oats tui**:
|
|
1202
|
-
|
|
1203
|
-
|
|
1375
|
+
family, shared with oats tui**: **Alt (default)**, **Ctrl+Alt (for
|
|
1376
|
+
programs that read Alt)** or **Ctrl+Shift (foot, Alacritty)**. The
|
|
1377
|
+
Desktop writes the file below and switches its keys at once. A change by
|
|
1378
|
+
hand reaches the Desktop when it next gets the focus.
|
|
1204
1379
|
- **Or by hand:** write `$OATS_HOME_DIR/config/keys.json`, else
|
|
1205
1380
|
`~/.oats/config/keys.json`, beside [`tui.json`](#change-the-keys-tuijson):
|
|
1206
1381
|
|
|
1207
1382
|
```json
|
|
1208
|
-
{ "chords": "ctrl+
|
|
1383
|
+
{ "chords": "ctrl+alt" }
|
|
1209
1384
|
```
|
|
1210
1385
|
|
|
1211
|
-
`"ctrl+alt"` is the default
|
|
1386
|
+
or `"ctrl+shift"`. `"alt"` is the default, and no file, or a file with no
|
|
1387
|
+
`chords`, is the default too.
|
|
1388
|
+
- **A choice is kept.** A keys.json that says `"ctrl+alt"`, written by the
|
|
1389
|
+
Desktop or by hand before this version, when Ctrl+Alt was the default,
|
|
1390
|
+
keeps the Ctrl+Alt family with the keys it had. Only a user who never
|
|
1391
|
+
chose moves to Alt. An older client that does not know the Alt family
|
|
1392
|
+
reads `"chords": "alt"` as a value it cannot take, so it binds its own
|
|
1393
|
+
default and says so.
|
|
1212
1394
|
- **`oats tui` reads it at its start:** restart it after a change, from the
|
|
1213
1395
|
Desktop or by hand.
|
|
1214
|
-
- **Nothing to fix when it is wrong.** A
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
only `chords` and keeps every other key in the file; a
|
|
1219
|
-
keep whole it leaves as it is, and says so.
|
|
1396
|
+
- **Nothing to fix when it is wrong.** A file that cannot be read or is
|
|
1397
|
+
larger than 16 KiB, one that is not a JSON object, one with another
|
|
1398
|
+
value: each means Alt, and the help says why (`keys.json: unknown chords
|
|
1399
|
+
value, using Alt`). A missing file is the default with nothing to say. The
|
|
1400
|
+
Desktop changes only `chords` and keeps every other key in the file; a
|
|
1401
|
+
file it cannot keep whole it leaves as it is, and says so.
|
|
1220
1402
|
- **It is the clients' file.** The kernel never reads it, and `tui.json`
|
|
1221
1403
|
does not hold it.
|
|
1222
1404
|
- **Your own keys still win, row by row.** A key you give an action in
|
|
1223
1405
|
`tui.json`'s `keys` is not bound as a chord, and an action you rebind in
|
|
1224
|
-
the Desktop's shortcuts editor keeps your key in
|
|
1225
|
-
editor shows a clash with a key
|
|
1226
|
-
- **In `oats tui` the
|
|
1227
|
-
([Chords](#chords)). Without it
|
|
1228
|
-
|
|
1229
|
-
|
|
1406
|
+
the Desktop's shortcuts editor keeps your key in every family; the
|
|
1407
|
+
editor shows a clash with a key a family takes.
|
|
1408
|
+
- **In `oats tui` the Ctrl+Alt and Ctrl+Shift families need the kitty
|
|
1409
|
+
keyboard protocol** ([Chords](#chords)). Without it `Ctrl+Alt+K` is `Esc`
|
|
1410
|
+
then `Ctrl+K`, and a Ctrl+Shift letter is the Ctrl letter, so the TUI
|
|
1411
|
+
binds none of them: only the Alt+Shift arrows, `Alt+Up` and `Alt+Down`
|
|
1412
|
+
are chords, and the leader does the rest. The Alt family needs nothing.
|
|
1230
1413
|
- **The help says which family is in force.** In `oats tui` the help (`?`)
|
|
1231
|
-
opens its chords with a line: `Shortcuts:
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1414
|
+
opens its chords with a line: `Shortcuts: Alt. To leave Alt to the
|
|
1415
|
+
programs in your terminals, set "chords": "ctrl+alt" in keys.json (or
|
|
1416
|
+
"ctrl+shift", for foot and Alacritty) and restart.`, or `Shortcuts:
|
|
1417
|
+
Ctrl+Alt, from keys.json.` (`Ctrl+Shift`, the same way), or, in a terminal
|
|
1418
|
+
that does not confirm the protocol, `Shortcuts: Ctrl+Alt, from keys.json,
|
|
1419
|
+
but this terminal does not confirm the kitty keyboard protocol: use the
|
|
1420
|
+
leader.` The Desktop's Shortcuts page shows the choice, `oats tui uses it
|
|
1421
|
+
from its next start.` under it, and the same note when the file was not
|
|
1422
|
+
taken.
|
|
1240
1423
|
|
|
1241
|
-
|
|
1242
|
-
|
|
1424
|
+
### What the Alt family takes
|
|
1425
|
+
|
|
1426
|
+
The Alt family's chords are keys that programs in a terminal read: the
|
|
1427
|
+
TUI takes them from every focus, an agent's terminal included, and the
|
|
1428
|
+
program never gets them. These are the keys it takes, by the programs' own
|
|
1429
|
+
key documentation (researched 2026-10-23; sources below). "Esc, then the
|
|
1430
|
+
key" works where the program says an `Esc` prefix is Meta: readline, zsh,
|
|
1431
|
+
Emacs and irssi do. Typed as two keys apart (more than 10 ms), `Esc` then
|
|
1432
|
+
the key reaches the program as those two bytes ([Chords](#chords)). Where a
|
|
1433
|
+
program's docs don't say, the way is marked unknown, and the Ctrl+Alt
|
|
1434
|
+
family gives the key back ([Switch family](#switch-family)). An Alt key no
|
|
1435
|
+
chord holds (`Alt+B`, `Alt+D`, `Alt+T`, `Alt+.`) is still the program's.
|
|
1436
|
+
|
|
1437
|
+
Unlike the Desktop's terminal, which sends an Alt arrow as the Ctrl arrow,
|
|
1438
|
+
the terminal you run `oats tui` in sends the Alt arrows as `CSI 1;3` (`Esc
|
|
1439
|
+
[1;3C` for `Alt+Right`), which programs read. So the TUI takes the Alt
|
|
1440
|
+
arrows from them too, in the Alt family. All four go back to the programs
|
|
1441
|
+
in the Ctrl+Alt and Ctrl+Shift families: `Alt+Up` and `Alt+Down`, the
|
|
1442
|
+
workspace moves, are the Alt family's alone.
|
|
1443
|
+
|
|
1444
|
+
| Program | Key the Alt family takes | What the program does with it | How it still gets it |
|
|
1445
|
+
|---|---|---|---|
|
|
1446
|
+
| Claude Code | `Alt+P` | the model picker | unknown: its docs don't say whether `Esc`, then `P` is Meta+P, and `Esc` alone interrupts; switch to Ctrl+Alt |
|
|
1447
|
+
| Claude Code | `Alt+O` | fast mode on or off | as `Alt+P` |
|
|
1448
|
+
| Claude Code | `Alt+F` | forward a word | as `Alt+P` |
|
|
1449
|
+
| Claude Code | `Alt+Up`, `Alt+Down` | in the `/diff` panel, the file list; in the agents view (`claude agents`), the group before or after | in the `/diff` panel `Ctrl+Up`, `Ctrl+Down`; in the agents view unknown |
|
|
1450
|
+
| Codex | `Alt+F` | a word right | `Ctrl+Right`, its other key for it |
|
|
1451
|
+
| Codex | `Alt+Left`, `Alt+Right` | the agent thread before or after, while the composer is empty; else a word left or right | the word moves: `Ctrl+Left`, `Ctrl+Right`; the threads: unknown, switch to Ctrl+Alt |
|
|
1452
|
+
| Codex | `Alt+Up` | edit the queued message | `Shift+Left` |
|
|
1453
|
+
| Codex | `Alt+Down` | back through the prompt stack | `Shift+Right` |
|
|
1454
|
+
| pi | `Alt+F` | a word right | `Esc`, then `f`: pi reads `ESC f` as a word right |
|
|
1455
|
+
| pi | `Alt+Left`, `Alt+Right` | a word left or right; in the session tree, fold or unfold | `Esc`, then `b` or `f`, which pi reads as `Alt+Left` and `Alt+Right` |
|
|
1456
|
+
| pi | `Alt+Up` | restore the queued messages to the editor; in the model selector, move a model up | `Esc`, then `p`, which pi reads as `Alt+Up` |
|
|
1457
|
+
| pi | `Alt+Down` | in the model selector, move a model down | `Esc`, then `n`, which pi reads as `Alt+Down` |
|
|
1458
|
+
| bash (readline) | `Alt+P`, `Alt+F` | search history back; forward a word | `Esc`, then `p` or `f` |
|
|
1459
|
+
| bash (readline) | `Alt+1` to `Alt+9` | a numeric argument | `Esc`, then the digit |
|
|
1460
|
+
| bash (readline) | `Alt+Left`, `Alt+Right` | a word back or forward | `Esc`, then `b` or `f` |
|
|
1461
|
+
| zsh (emacs keymap) | `Alt+P`, `Alt+Z`, `Alt+W`, `Alt+F` | history search back; run the last named command; copy the region; forward a word | `Esc`, then the letter |
|
|
1462
|
+
| zsh (emacs keymap) | `Alt+1` to `Alt+9` | a numeric argument | `Esc`, then the digit |
|
|
1463
|
+
| irssi | `Alt+1` to `Alt+9`; `Alt+W`, `E`, `O` | go to window 1 to 9; to window 12, 13, 19 | `Esc`, then the key |
|
|
1464
|
+
| irssi | `Alt+K`, `P`, `F` | erase completion; page back; forward a word | `Esc`, then the key |
|
|
1465
|
+
| irssi | `Alt+Left`, `Alt+Right`; `Alt+Up`, `Alt+Down` | the window before or after in the split; the split window above or below | its `/window` commands; for `Alt+Left`, `Alt+Right`, switch to Ctrl+Alt |
|
|
1466
|
+
| WeeChat | `Alt+1` to `Alt+9` | go to buffer 1 to 9 | unknown; switch to Ctrl+Alt |
|
|
1467
|
+
| WeeChat | `Alt+K`, `F`, `P`, `Z`, `W` | grab a key; next word; previous highlight; zoom; `Alt+W` starts the window keys | unknown; switch to Ctrl+Alt |
|
|
1468
|
+
| WeeChat | `Alt+Left`, `Alt+Up`; `Alt+Right`, `Alt+Down` | the buffer before; after | `F5`, `F6` |
|
|
1469
|
+
| tmux | nothing without the prefix (the root table binds only the mouse) | after the prefix: `Alt+1` to `Alt+7` the preset layouts, `Alt+O`, `P`, `N` rotate the panes and go to a window with an alert, the Alt arrows resize the pane | its commands (`select-layout`, `resize-pane`), or switch to Ctrl+Alt: `Esc`, then the key is read as Alt only within `escape-time` (below), so not by hand |
|
|
1470
|
+
| Emacs (`emacs -nw`) | `Alt+K`, `E`, `Shift+E`, `Z`, `W`, `F` | kill-sentence, forward-sentence (with Shift too), zap-to-char, kill-ring-save, forward-word | `Esc`, then the letter |
|
|
1471
|
+
| Emacs | `Alt+1` to `Alt+9` | a numeric argument | `Esc`, then the digit |
|
|
1472
|
+
| Emacs | `Alt+Left`, `Alt+Right` | a word left or right | `Esc`, then `b` or `f` |
|
|
1473
|
+
|
|
1474
|
+
Not taken from these programs, by their docs: `Alt+K`, `Z`, `W`, `E` and `R`
|
|
1475
|
+
in Claude Code; the Alt+Shift arrows everywhere above but in WeeChat's
|
|
1476
|
+
cursor mode; `Alt+O` in Emacs since 28; `Alt+A` from every one of them,
|
|
1477
|
+
since the Alt family leaves it alone (the next group is `Alt+Shift+Right`
|
|
1478
|
+
there); and `Alt+R` from every one of them in `oats tui`, which binds no
|
|
1479
|
+
key for the Desktop's `edit-instance` ([Chords](#chords)): Codex's raw
|
|
1480
|
+
output, readline's revert-line, WeeChat's delete-line and Emacs's
|
|
1481
|
+
move-to-window-line keep it here, though the Desktop takes it. On macOS only
|
|
1482
|
+
the arrow rows apply: there `oats tui` takes the ⌥ arrows alone, where the
|
|
1483
|
+
terminal sends them as such ([Chords on macOS](#chords-on-macos)).
|
|
1484
|
+
|
|
1485
|
+
**Inside tmux.** `oats tui` run in a tmux pane gets its keys through tmux,
|
|
1486
|
+
which reads an `Esc` followed by a key within its `escape-time` (10 ms by
|
|
1487
|
+
default in tmux 3.7c) as that key with Alt, and passes it on as one. With
|
|
1488
|
+
a large `escape-time` (some configurations set 500 ms), `Esc` then `k`
|
|
1489
|
+
typed quickly is `Alt+K` and opens the palette, and an `Esc` pressed alone
|
|
1490
|
+
reaches `oats tui` only when that time is over. With the default, as
|
|
1491
|
+
outside tmux, only one keypress is a chord.
|
|
1492
|
+
|
|
1493
|
+
Sources: Claude Code [interactive mode](https://code.claude.com/docs/en/interactive-mode)
|
|
1494
|
+
and [keybindings](https://code.claude.com/docs/en/keybindings); Codex
|
|
1495
|
+
[`keymap.rs`](https://github.com/openai/codex/blob/d6817454d76885e9d0e118bbf82e507aed6f715a/codex-rs/tui/src/keymap.rs)
|
|
1496
|
+
and [`app/input.rs`](https://github.com/openai/codex/blob/d6817454d76885e9d0e118bbf82e507aed6f715a/codex-rs/tui/src/app/input.rs);
|
|
1497
|
+
pi [`keybindings.md`](https://github.com/badlogic/pi-mono/blob/42cb822f1c5d3153069dd0661bfd297424666cf1/packages/coding-agent/docs/keybindings.md)
|
|
1498
|
+
and [`keys.ts`](https://github.com/badlogic/pi-mono/blob/42cb822f1c5d3153069dd0661bfd297424666cf1/packages/tui/src/keys.ts);
|
|
1499
|
+
the [Readline manual](https://tiswww.case.edu/php/chet/readline/readline.html)
|
|
1500
|
+
("Typing 'ESC f' is equivalent to typing M-f") and readline 8.3's `readline.c`
|
|
1501
|
+
for the Alt arrows; the [zsh line editor](https://zsh.sourceforge.io/Doc/Release/Zsh-Line-Editor.html);
|
|
1502
|
+
irssi's [startup HOWTO](https://github.com/irssi/irssi/blob/43f1727ef9fe1cb51d5031ee2dd0e1965217e4cb/docs/startup-HOWTO.txt)
|
|
1503
|
+
and [`gui-readline.c`](https://github.com/irssi/irssi/blob/43f1727ef9fe1cb51d5031ee2dd0e1965217e4cb/src/fe-text/gui-readline.c);
|
|
1504
|
+
the [WeeChat user guide](https://weechat.org/files/doc/weechat/stable/weechat_user.en.html#key_bindings) (4.10.1);
|
|
1505
|
+
[tmux(1)](https://man7.org/linux/man-pages/man1/tmux.1.html); the
|
|
1506
|
+
[Emacs manual](https://www.gnu.org/software/emacs/manual/html_node/emacs/User-Input.html)
|
|
1507
|
+
(ESC as Meta) and its Sentences, Words, Moving Point, Other Kill Commands and
|
|
1508
|
+
Arguments nodes.
|
|
1509
|
+
|
|
1510
|
+
<a id="what-the-option-takes-from-an-agent"></a>
|
|
1511
|
+
|
|
1512
|
+
### What the Ctrl+Shift family takes from an agent
|
|
1513
|
+
|
|
1514
|
+
With the Ctrl+Shift family, both clients take its seven Ctrl+Shift chords
|
|
1515
|
+
from every focus, an agent's terminal included: the agent never gets them.
|
|
1243
1516
|
|
|
1244
1517
|
- **Of the agents' own keys, that is one:** pi's Ctrl+Shift+P (previous
|
|
1245
1518
|
model, [pi's keys](https://github.com/earendil-works/pi/blob/26293e74f664c2cfb731b22a653cccf852830e00/packages/coding-agent/docs/keybindings.md#L154))
|
|
@@ -1271,7 +1544,7 @@ every focus, an agent's terminal included: the agent never gets them.
|
|
|
1271
1544
|
| `1` | the Instances view |
|
|
1272
1545
|
| `2` | [the Souls view](#the-souls-view); `Esc` or `1` goes back |
|
|
1273
1546
|
| `3` | [the Capabilities view](#the-capabilities-view); `Esc` or `1` goes back |
|
|
1274
|
-
| `w` | opens [the switcher](#the-switcher) |
|
|
1547
|
+
| `w` | gives [the list of workspaces](#the-list-of-workspaces) the focus; `w` there opens [the switcher](#the-switcher) |
|
|
1275
1548
|
| `Delete` | in the switcher, asks whether to remove the selected row from this computer's list of deployments; `Enter` removes it |
|
|
1276
1549
|
| `Enter` | in the list of instances, opens the selected agent's terminal in a new [tab](#tabs) beside the sidebar, or shows its tab when it has one, with the focus in it; in the switcher, opens the selected row; in a confirmation, presses the button with the focus |
|
|
1277
1550
|
| `z` | gives the shown terminal the focus and the whole screen |
|
|
@@ -1280,7 +1553,7 @@ every focus, an agent's terminal included: the agent never gets them.
|
|
|
1280
1553
|
| `\|`, `-` | in the Instances view, [splits](#splits) the panel side by side or one above the other |
|
|
1281
1554
|
| `Ctrl+X` | [the leader](#the-leader), from every focus ([`tui.json`](#change-the-keys-tuijson) can name another key) |
|
|
1282
1555
|
| `Ctrl+K` | opens [the palette](#the-palette); `Ctrl+K` again closes it |
|
|
1283
|
-
| `
|
|
1556
|
+
| `Alt+K`, `Alt+Shift+Up` and the other [chords](#chords) (`Ctrl+Alt+K` or `Ctrl+Shift+K` and the rest [in the other families](#switch-family)) | what the leader then a key does, from every focus (`Alt+Shift+Up`, `Alt+Shift+Down`: the instance before or after, which the leader has no key for); the Ctrl+Alt and Ctrl+Shift ones where your terminal sends them. While [the palette](#the-palette) is open, `Alt+Shift+Up` and `Alt+Shift+Down` are its own |
|
|
1284
1557
|
| `X`, `D`, `S`, `R` | stop, retire, start, restart the selected agent, [after a confirmation](#stopping-starting-restarting-and-retiring) |
|
|
1285
1558
|
| `n` | [spawns an agent](#spawning-an-agent): the soul picker, then the preview |
|
|
1286
1559
|
| `N` | spawns another of the selected instance's soul: its preview |
|
|
@@ -1303,8 +1576,9 @@ where it is, and the list returns to it at the next key that moves it.
|
|
|
1303
1576
|
|
|
1304
1577
|
The help screen is generated from the table the program acts on, so it
|
|
1305
1578
|
always lists the keys that work, the leader's among them, the
|
|
1306
|
-
[chords](#chords) (first of all while
|
|
1307
|
-
|
|
1579
|
+
[chords](#chords) (first of all while every chord of the family in force
|
|
1580
|
+
is read: always in the Alt family, and in the others while your terminal
|
|
1581
|
+
confirms the kitty keyboard protocol), the palette's and the spawn prompt's, with the
|
|
1308
1582
|
marks and with what this version does not do. Its top row has the time of the read and the count of withheld rows
|
|
1309
1583
|
([What it shows](#what-it-shows)). The movement keys scroll it. While
|
|
1310
1584
|
a terminal has the focus the table's keys are the agent's: the leader and
|
|
@@ -1331,37 +1605,35 @@ which edits the command line in your editor, is `Ctrl+X` twice, then
|
|
|
1331
1605
|
|---|---|
|
|
1332
1606
|
| `k` or `Space` | opens [the palette](#the-palette) |
|
|
1333
1607
|
| `1`, `2`, `3` | the Instances, Souls and Capabilities views |
|
|
1334
|
-
| `Up`, `Down` | opens the
|
|
1608
|
+
| `Up`, `Down` | opens the workspace before or after the open one, in [the list of workspaces](#the-list-of-workspaces) as it is drawn (the chords `Alt+Up`, `Alt+Down`). Every row opens, and the list does not wrap. The terminal of the instance before or after is `Alt+Shift+Up`, `Alt+Shift+Down` ([Chords](#chords)) |
|
|
1335
1609
|
| `Left`, `Right` | shows the tab before or after the shown one; the tab bar does not wrap, and the focus stays where it was |
|
|
1336
1610
|
| `z` | zooms the shown terminal in or out; with the list focused, gives it the focus and the whole screen |
|
|
1337
1611
|
| `w` | closes the shown terminal's tab and shows the tab beside it; the agent keeps running |
|
|
1338
1612
|
| `\|`, `-` | [splits](#splits) the panel side by side or one above the other |
|
|
1339
1613
|
| `Tab` | goes to the other group's terminal (or to the other group, when it is empty); from the list, to the focused group's |
|
|
1614
|
+
| `Shift+Tab` | goes to the previous group, as `Tab` goes to the next: with two groups at most, the same as `Tab` |
|
|
1340
1615
|
| `m` | with two groups, moves the shown tab to the other group, and goes there |
|
|
1341
1616
|
| `x` | closes the focused group while it is empty |
|
|
1342
1617
|
| `X`, `R`, `S`, `D` | stop, restart, start, retire, [after a confirmation](#stopping-starting-restarting-and-retiring): from a terminal's focus on that terminal's instance, which has the focus again when the confirmation closes |
|
|
1343
1618
|
| `n`, `N` | [spawns an agent](#spawning-an-agent); `N` of the shown terminal's soul from its focus |
|
|
1344
1619
|
| `/` | the filter |
|
|
1345
|
-
| `o` | [the
|
|
1620
|
+
| `o` | gives [the list of workspaces](#the-list-of-workspaces) the focus |
|
|
1346
1621
|
| `?` | the help |
|
|
1347
1622
|
| `Esc` | gives the list the focus |
|
|
1348
|
-
| the leader again | types the leader into the terminal that has the focus, which keeps it; with the list focused, only
|
|
1349
|
-
|
|
1350
|
-
- **While the leader waits** for its key
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
panel has one group, `Tab` with two, then `m` while the focused group
|
|
1355
|
-
shows a tab or `x` while it is empty, and the leader again while a
|
|
1356
|
-
terminal has the focus). On a short screen it gives up rows before its
|
|
1357
|
-
last. It waits
|
|
1358
|
-
with no time limit. A key not in the table cancels it and is dropped:
|
|
1359
|
-
nothing is typed.
|
|
1623
|
+
| the leader again | types the leader into the terminal that has the focus, which keeps it; with the list focused, only cancels the leader |
|
|
1624
|
+
|
|
1625
|
+
- **While the leader waits** for its key nothing on the screen changes:
|
|
1626
|
+
the cheat sheet stays as it was, and the help (`?`) lists the whole
|
|
1627
|
+
table above. It waits with no time limit. A key not in the table
|
|
1628
|
+
cancels it and is dropped: nothing is typed.
|
|
1360
1629
|
- **Only a key in a later read counts.** A key that came in the same read of
|
|
1361
1630
|
input as the leader cancels it and is dropped, with the rest of that
|
|
1362
|
-
read, so a paste can never run a command.
|
|
1363
|
-
the
|
|
1364
|
-
|
|
1631
|
+
read, so a paste can never run a command. The line under the list of workspaces says
|
|
1632
|
+
so, until the next key of any kind (one typed to an agent too) or a resize:
|
|
1633
|
+
`Ctrl+X and the next key came in one read, so nothing ran: press them
|
|
1634
|
+
one after the other.` In a terminal the bytes before the leader in that
|
|
1635
|
+
read still go to the agent. A leader inside a bracketed paste is pasted
|
|
1636
|
+
text.
|
|
1365
1637
|
- **`Ctrl+X` is one byte.** Without the kitty keyboard protocol
|
|
1366
1638
|
([Chords](#chords)) every terminal sends it as `0x18`, which no read
|
|
1367
1639
|
splits and nothing has to time; under the protocol it is `CSI 120;5u`,
|
|
@@ -1373,6 +1645,9 @@ which edits the command line in your editor, is `Ctrl+X` twice, then
|
|
|
1373
1645
|
`Esc` then `0x18` in one read is `Ctrl+Alt+X`, and goes to the agent.
|
|
1374
1646
|
- **An Alt leader is one keypress only.** A leader `tui.json` names with
|
|
1375
1647
|
`M-`, such as `M-o` (`Alt+O`), is sent by a terminal as `Esc` then `o`.
|
|
1648
|
+
A leader that is a chord of the family in force is the leader, and that
|
|
1649
|
+
chord is not bound: with `M-o`, `Alt+O` is the leader, and the leader
|
|
1650
|
+
then `o` gives the list of workspaces the focus.
|
|
1376
1651
|
Those bytes count as the leader when they arrive in one read, or split
|
|
1377
1652
|
across reads within 10 ms. An `Esc` then `o` typed as two keys reaches
|
|
1378
1653
|
the agent unchanged: in vim that is "leave insert mode, open a line".
|
|
@@ -1395,33 +1670,76 @@ which edits the command line in your editor, is `Ctrl+X` twice, then
|
|
|
1395
1670
|
### Chords
|
|
1396
1671
|
|
|
1397
1672
|
A chord does in one keypress what the leader then a key does, from every
|
|
1398
|
-
focus, an agent's terminal too, and never reaches the agent.
|
|
1673
|
+
focus, an agent's terminal too, and never reaches the agent. One pair has
|
|
1674
|
+
no leader key: `Alt+Shift+Up` and `Alt+Shift+Down` open the terminal of
|
|
1675
|
+
the instance before or after, in the list as it is drawn, the focus in it
|
|
1676
|
+
(from the shown terminal's instance, or from the selection when none is
|
|
1677
|
+
open; its tab when it has one, else a new [tab](#tabs); rows that cannot be
|
|
1678
|
+
opened are passed over, and the list does not wrap), since the leader's
|
|
1679
|
+
`Up` and `Down` move between workspaces. On macOS, where that pair holds ⌘
|
|
1680
|
+
(`⌥⌘↑`, `⌥⌘↓`), which a terminal never passes on, the list's `Up` or
|
|
1681
|
+
`Down` then `Enter` does it. The OATS
|
|
1399
1682
|
Desktop has the same chords (`CHORDS` in `packages/client/keymap.mjs`, which
|
|
1400
1683
|
both read; the TUI keeps no copy). The leader stays the key that always
|
|
1401
1684
|
works, and the one for help, the views and the acts (stop, restart, start,
|
|
1402
1685
|
retire), which have no chord.
|
|
1403
1686
|
|
|
1404
|
-
Every chord, in
|
|
1687
|
+
Every chord, in every family, with what it does and the leader's key for
|
|
1405
1688
|
it, is in [Every action's keys](#every-actions-keys). While the palette is
|
|
1406
1689
|
open, `Alt+Shift+Up` and `Alt+Shift+Down` move between its groups instead
|
|
1407
1690
|
([The palette](#the-palette)).
|
|
1408
1691
|
|
|
1409
|
-
`CHORDS` also holds the Desktop's `edit-instance` (`
|
|
1692
|
+
`CHORDS` also holds the Desktop's `edit-instance` (`Alt+R`, its name and
|
|
1410
1693
|
colour dialog). The TUI has no such action, so it binds no key for it and
|
|
1411
|
-
`
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
Ctrl+
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1694
|
+
`Alt+R` stays the agent's.
|
|
1695
|
+
|
|
1696
|
+
There are three families, one choice per user for both clients
|
|
1697
|
+
([Switch family](#switch-family)):
|
|
1698
|
+
|
|
1699
|
+
- **Alt, the default.** Alt with a letter or a digit acts, Alt with an
|
|
1700
|
+
arrow moves between tabs and workspaces, and Alt+Shift with an arrow
|
|
1701
|
+
between groups and instances. It reads in every terminal, with no
|
|
1702
|
+
protocol, and takes keys that programs in a terminal read
|
|
1703
|
+
([What the Alt family takes](#what-the-alt-family-takes)).
|
|
1704
|
+
- **Ctrl+Alt, for whoever needs Alt in their programs.** The default
|
|
1705
|
+
before this version, with its keys: Ctrl+Alt with a letter or a digit
|
|
1706
|
+
acts, and Alt+Shift with an arrow moves between tabs and instances. It
|
|
1707
|
+
leaves Alt alone, the Alt arrows included: the workspace moves have no
|
|
1708
|
+
chord here, so `Alt+Up` and `Alt+Down` reach the program (Codex's edit
|
|
1709
|
+
the queued message, pi's restore the queued messages), and the leader's
|
|
1710
|
+
`Up` and `Down` move between workspaces. No terminal in [the
|
|
1711
|
+
matrix](#which-terminals-let-the-chords-through) takes its chords by
|
|
1712
|
+
default, and no agent (Claude Code, Codex, pi) reads them. It needs the
|
|
1713
|
+
kitty keyboard protocol.
|
|
1714
|
+
- **Ctrl+Shift, for a terminal that passes Ctrl+Shift apart from Ctrl**
|
|
1715
|
+
(foot, Alacritty). Ctrl+Shift with a letter, the obvious family, is
|
|
1716
|
+
mostly the terminals' own: kitty binds 22 of those letters, Ghostty 13,
|
|
1717
|
+
and foot, GNOME Terminal, WezTerm, Konsole and Windows Terminal their
|
|
1718
|
+
own. So seven of the Ctrl+Alt family's chords move to Ctrl+Shift, for the
|
|
1719
|
+
terminals that leave those letters alone ([Which family for my
|
|
1720
|
+
terminal](#which-family-for-my-terminal)), and the others keep their
|
|
1721
|
+
Ctrl+Alt key. It needs the protocol too.
|
|
1722
|
+
|
|
1723
|
+
A chord of another family is no chord: in the Alt family `Ctrl+Alt+K`
|
|
1724
|
+
reaches the agent as it would without the TUI, and in the Ctrl+Alt family
|
|
1725
|
+
`Alt+K` does. On macOS the TUI has the ⌥ arrows alone ([Chords on
|
|
1726
|
+
macOS](#chords-on-macos)): the Desktop's other chords hold ⌘, which a
|
|
1727
|
+
terminal never passes to a program.
|
|
1728
|
+
|
|
1729
|
+
- **The Alt family in every terminal.** A terminal sends `Alt` with a
|
|
1730
|
+
letter or a digit as `Esc` then the key (`Alt+K` is `ESC k`, and
|
|
1731
|
+
`Alt+Shift+E` is `ESC E`), with the protocol or without it, and the
|
|
1732
|
+
arrows as sequences of their own (`CSI 1;3A` for `Alt+Up`, `CSI 1;4A` for
|
|
1733
|
+
`Alt+Shift+Up`). Under the protocol each is one report of its own. In the
|
|
1734
|
+
list a lone `Esc` waits 50 ms for a key after it, as it always has. In a
|
|
1735
|
+
terminal `Esc` and the key are one chord when they come in one read, or
|
|
1736
|
+
split across reads within 10 ms, as an [Alt leader](#the-leader) is: an
|
|
1737
|
+
`Esc` then `k` typed as two keys reaches the agent unchanged, so a
|
|
1738
|
+
program that reads `Esc` as Meta, as the shell does, still gets `Alt+K`
|
|
1739
|
+
that way. Over a slow link two keys typed apart can arrive in one read
|
|
1740
|
+
and act as the chord, and one chord can arrive split and reach the agent
|
|
1741
|
+
as `Esc` and the key. Inside tmux, its `escape-time` decides ([What the
|
|
1742
|
+
Alt family takes](#what-the-alt-family-takes)).
|
|
1425
1743
|
- **The Ctrl+Alt and Ctrl+Shift chords only where the terminal says it
|
|
1426
1744
|
can.** Without the kitty keyboard protocol a terminal sends `Ctrl+Alt+K`
|
|
1427
1745
|
as `Esc` then `Ctrl+K`, the same bytes as those two keys typed for the
|
|
@@ -1429,45 +1747,51 @@ hold ⌘, which a terminal never passes to a program.
|
|
|
1429
1747
|
it takes the terminal, `oats tui` asks for the protocol with flags 1 and 4
|
|
1430
1748
|
(`CSI > 5 u`) and asks the terminal which flags it has (`CSI ? u`). Only
|
|
1431
1749
|
when the answer holds flag 1 does it read the protocol and take the
|
|
1432
|
-
chords of
|
|
1433
|
-
it pops the protocol, and the rest of the run is as without it
|
|
1750
|
+
chords of those families. With no answer within 2 seconds, or one without flag 1,
|
|
1751
|
+
it pops the protocol, and the rest of the run is as without it: of those
|
|
1752
|
+
families' chords only the arrows are taken (the Alt+Shift arrows). The
|
|
1434
1753
|
answer may come split and late over a slow link, so until it comes (at
|
|
1435
1754
|
most those 2 seconds) an `Esc` pressed on its own may wait for the next
|
|
1436
1755
|
key or for the wait's end, as it may begin the answer.
|
|
1437
|
-
- **The
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1756
|
+
- **The help and the cheat sheet lead with the chords** while every chord
|
|
1757
|
+
of the family in force is read: always in the Alt family and on macOS,
|
|
1758
|
+
and in the others while the terminal confirms the protocol. Then the help has one
|
|
1759
|
+
row per chord, then the leader and its key ("or `Ctrl+X` then `k`"), and
|
|
1760
|
+
the leader's own section after them; a pair whose keys share their
|
|
1761
|
+
modifiers is one row (`Alt+Shift+Up/Down`), and `Ctrl+Alt+Shift+A` and
|
|
1762
|
+
`Ctrl+Alt+A` are a row each. Otherwise the leader leads, and only the
|
|
1763
|
+
chords read are listed. The help's chords open with the family in force
|
|
1764
|
+
([Switch family](#switch-family)). The cheat sheet names chords while an
|
|
1765
|
+
agent's terminal has the focus; the list's names its own keys, which need
|
|
1766
|
+
no modifier.
|
|
1448
1767
|
- **Your terminal may take some first** ([the matrix](#which-terminals-let-the-chords-through)).
|
|
1449
|
-
|
|
1450
|
-
|
|
1768
|
+
GNOME Terminal and Konsole take `Alt+1` to `Alt+9` for their own tabs
|
|
1769
|
+
while they have two or more, and Ghostty when the tab changes. Windows
|
|
1770
|
+
Terminal takes the Alt and Alt+Shift arrows while its panes are split,
|
|
1771
|
+
and `Ctrl+Alt+1` to `Ctrl+Alt+9` for its own tabs. GNOME Terminal and the
|
|
1451
1772
|
other VTE terminals, Konsole before 26.08, and WezTerm unless
|
|
1452
|
-
`enable_kitty_keyboard` is set have no protocol: there
|
|
1453
|
-
arrows reach `oats tui`.
|
|
1773
|
+
`enable_kitty_keyboard` is set have no protocol: there the Ctrl+Alt and
|
|
1774
|
+
Ctrl+Shift families' chords but their arrows do not reach `oats tui`.
|
|
1775
|
+
The leader works in every terminal.
|
|
1454
1776
|
- **A character typed with AltGr stays a character.** On Windows `AltGr` is
|
|
1455
1777
|
`Ctrl+Alt`: on a Spanish layout `Ctrl+Alt+E` types `€` and `Ctrl+Alt+2`
|
|
1456
1778
|
`@`, on a Polish one `Ctrl+Alt+A` types `ą`. A key that arrives as text is
|
|
1457
1779
|
never a chord: on such a layout those chords are the layout's, and the
|
|
1458
|
-
leader still does what they do. On Linux
|
|
1459
|
-
|
|
1780
|
+
leader still does what they do. On Linux `AltGr` is a key of its own: a
|
|
1781
|
+
character it types reaches the TUI as that character, never as `Esc`
|
|
1782
|
+
then a key, so it is never an Alt chord either. On macOS Option is a key
|
|
1783
|
+
of its own.
|
|
1460
1784
|
- **Every other key reads as it does without the protocol.** `Ctrl+Shift+L`
|
|
1461
1785
|
is `Ctrl+L`, `Ctrl+Enter` is `Enter`, and so on: the protocol only adds
|
|
1462
|
-
the chords of the family in force, tells an Alt
|
|
1463
|
-
from `Esc` then `o` exactly, and
|
|
1464
|
-
`Ctrl+X` ([The leader](#the-leader)).
|
|
1465
|
-
Ctrl+Shift
|
|
1466
|
-
`Ctrl+D`.
|
|
1786
|
+
the Ctrl+Alt and Ctrl+Shift chords of the family in force, tells an Alt
|
|
1787
|
+
chord or an Alt leader such as `Alt+O` from `Esc` then `o` exactly, and
|
|
1788
|
+
tells `Ctrl+Shift+X` from the leader `Ctrl+X` ([The leader](#the-leader)).
|
|
1789
|
+
Outside the Ctrl+Shift family its seven Ctrl+Shift letters are such keys
|
|
1790
|
+
too: `Ctrl+Shift+D` is `Ctrl+D`.
|
|
1467
1791
|
- **A Ctrl+Shift chord is read from the protocol alone,** from a report
|
|
1468
1792
|
that holds Shift, never from the byte a terminal sends without it:
|
|
1469
|
-
`Ctrl+D` (end of input) and `Enter` (`Ctrl+M`) stay what they are,
|
|
1470
|
-
the
|
|
1793
|
+
`Ctrl+D` (end of input) and `Enter` (`Ctrl+M`) stay what they are, in
|
|
1794
|
+
the Ctrl+Shift family too.
|
|
1471
1795
|
- **An agent gets what it gets without the protocol.** Every key typed
|
|
1472
1796
|
into an agent's terminal is turned back into the bytes the same key sends
|
|
1473
1797
|
without it, the legacy encoding of xterm and the terminals that follow it:
|
|
@@ -1489,38 +1813,112 @@ hold ⌘, which a terminal never passes to a program.
|
|
|
1489
1813
|
terminal: the shell at a suspend is the only one `oats tui` ever gives
|
|
1490
1814
|
it to.
|
|
1491
1815
|
|
|
1816
|
+
#### Chords on macOS
|
|
1817
|
+
|
|
1818
|
+
On macOS `oats tui` binds the chords of `CHORDS` whose key holds no ⌘, ⌥
|
|
1819
|
+
with an arrow (the product owner's call, 2026-10-23): `⌥←` and `⌥→` the tab before or
|
|
1820
|
+
after, `⌥⇧←` and `⌥⇧→` the group before or after, `⌥↑` and `⌥↓` the
|
|
1821
|
+
workspace before or after. Its help and cheat sheet say them `Alt+Left` and
|
|
1822
|
+
so on, and lead with them. The other chords hold ⌘ (`⌘K`, `⌥⌘1` to `⌥⌘9`,
|
|
1823
|
+
`⌥⌘↑`), which a terminal never passes to a program, so the TUI binds none
|
|
1824
|
+
of them. The leader does the actions it has a key for (`Ctrl+X` then `k`
|
|
1825
|
+
for the palette, for instance); the list's `Up` or `Down`, then `Enter`,
|
|
1826
|
+
steps between instances; and no key goes to a tab by its place, so no tab
|
|
1827
|
+
carries a number ([Tabs](#tabs)). ⌥ with a letter or a digit
|
|
1828
|
+
types a character on many layouts (`⌥2` is `@` on a Spanish one), so none
|
|
1829
|
+
of them is a chord. There is no family to choose: keys.json's `chords` is
|
|
1830
|
+
not read there.
|
|
1831
|
+
|
|
1832
|
+
A chord comes only where the terminal sends ⌥ with an arrow as its xterm
|
|
1833
|
+
sequence, `CSI 1;3` (`Esc [1;3D` for `⌥←`), and ⌥⇧ with one as `CSI 1;4`.
|
|
1834
|
+
Where it comes, the TUI takes it from the program in the terminal, as on
|
|
1835
|
+
Linux; where it does not, the bytes reach the program as before (`Esc b`
|
|
1836
|
+
and `Esc f` move a shell by word), and the leader does what the chord
|
|
1837
|
+
would: then `Left` or `Right` for the tabs, `Shift+Tab` or `Tab` for the
|
|
1838
|
+
groups, `Up` or `Down` for the workspaces. What each terminal sends by
|
|
1839
|
+
default, read from its source or its documentation on 2026-10-23 (their
|
|
1840
|
+
main branches):
|
|
1841
|
+
|
|
1842
|
+
| Terminal | `⌥←`, `⌥→` | `⌥↑`, `⌥↓` | `⌥⇧←`, `⌥⇧→` | For the chords |
|
|
1843
|
+
|---|---|---|---|---|
|
|
1844
|
+
| Terminal.app | `Esc b`, `Esc f`, the shell's word moves ([ncurses' `nsterm` entry][nsterm], [Apple][apple-keys]) | unknown | unknown | unknown: [Apple][apple-kbd] does not say whether "Use Option as Meta key" or the profile's key list changes what an arrow sends |
|
|
1845
|
+
| iTerm2 | the chord | the chord | the chord | the default ([its profile][iterm-profile], [the encoder][iterm-encoder]: "Treat ⌥ as Alt for special keys"); its presets "Natural Text Editing" and "Terminal.app Compatibility" ([presets][iterm-presets]) map `⌥←`, `⌥→` (the second `⌥↑`, `⌥↓` too) to the shell's moves instead |
|
|
1846
|
+
| Ghostty | `Esc b`, `Esc f`, its own default keybinds ([config][ghostty-binds], [#3106][ghostty-3106]) | the chord ([encoder][ghostty-encoder]) | the chord | `keybind = alt+left=unbind` and `keybind = alt+right=unbind` |
|
|
1847
|
+
| kitty | the chord ([Option is Alt][kitty-option], [encoder][kitty-encoder]) | the chord | the chord | the default |
|
|
1848
|
+
| WezTerm | the chord ([config][wezterm-config], [encoder][wezterm-encoder]) | the chord | the chord | the default |
|
|
1849
|
+
| Alacritty | the chord ([Alt on named keys][alacritty-keys]) | the chord | the chord | the default |
|
|
1850
|
+
| Warp | the chord in a full-screen program, as `oats tui` is ([encoder][warp-encoder], [binds][warp-binds]) | its own default bind (bookmarks); unknown whether it takes them from a full-screen program | the chord | its keybinding editor |
|
|
1851
|
+
| VS Code's terminal | `Esc b`, `Esc f` ([its default bindings][vscode-binds]) | `CSI 1;5A`, `CSI 1;5B`, which is `Ctrl+Up`, `Ctrl+Down`: no chord | the chord | remove its `workbench.action.terminal.sendSequence` bindings of `alt+left`, `alt+right`, `alt+up` and `alt+down` in keybindings.json |
|
|
1852
|
+
|
|
1853
|
+
iTerm2's, WezTerm's and Warp's rows were read from their code, not run.
|
|
1854
|
+
Neither "Use Option as Meta key" (Terminal.app) nor Option as Alt or Meta in
|
|
1855
|
+
the others (iTerm2's Left/Right Option key, Ghostty's
|
|
1856
|
+
`macos-option-as-alt`, kitty's `macos_option_as_alt`, Alacritty's
|
|
1857
|
+
`option_as_alt`, VS Code's `terminal.integrated.macOptionIsMeta`) changes
|
|
1858
|
+
what the arrows send, by those terminals' code; for Terminal.app it is
|
|
1859
|
+
unknown. The TUI reads no other bytes as these chords: `Esc b` and `Esc f`
|
|
1860
|
+
are readline's word moves, and `CSI 1;5A` is `Ctrl+Up`.
|
|
1861
|
+
|
|
1862
|
+
[nsterm]: https://github.com/ThomasDickey/ncurses-snapshots/blob/master/misc/terminfo.src
|
|
1863
|
+
[apple-keys]: https://support.apple.com/guide/terminal/keyboard-shortcuts-trmlshtcts/mac
|
|
1864
|
+
[apple-kbd]: https://support.apple.com/guide/terminal/profiles-keyboard-settings-trmlkbrd/mac
|
|
1865
|
+
[iterm-profile]: https://github.com/gnachman/iTerm2/blob/7f4ff739721f95d0b93003d8701c4523a7edf261/sources/Settings/iTermProfilePreferences.m#L1254
|
|
1866
|
+
[iterm-encoder]: https://github.com/gnachman/iTerm2/blob/7f4ff739721f95d0b93003d8701c4523a7edf261/sources/VT100/VT100Output.m#L1242
|
|
1867
|
+
[iterm-presets]: https://github.com/gnachman/iTerm2/blob/7f4ff739721f95d0b93003d8701c4523a7edf261/plists/PresetKeyMappings.plist#L127
|
|
1868
|
+
[ghostty-binds]: https://github.com/ghostty-org/ghostty/blob/08a9518340e19487bd5fdf96963583fb32f0c41f/src/config/Config.zig#L7383
|
|
1869
|
+
[ghostty-3106]: https://github.com/ghostty-org/ghostty/issues/3106
|
|
1870
|
+
[ghostty-encoder]: https://github.com/ghostty-org/ghostty/blob/08a9518340e19487bd5fdf96963583fb32f0c41f/src/input/function_keys.zig#L81
|
|
1871
|
+
[kitty-option]: https://github.com/kovidgoyal/kitty/blob/34eda431940fc8d66ffd0ada7d4a6451fdbd6699/kitty/options/definition.py#L3499
|
|
1872
|
+
[kitty-encoder]: https://github.com/kovidgoyal/kitty/blob/34eda431940fc8d66ffd0ada7d4a6451fdbd6699/kitty/key_encoding.c#L160
|
|
1873
|
+
[wezterm-config]: https://github.com/wezterm/wezterm/blob/e2a98e1b8af156988ad0ac778658ac27b60a55fb/config/src/config.rs#L461
|
|
1874
|
+
[wezterm-encoder]: https://github.com/wezterm/wezterm/blob/e2a98e1b8af156988ad0ac778658ac27b60a55fb/termwiz/src/input.rs#L421
|
|
1875
|
+
[alacritty-keys]: https://github.com/alacritty/alacritty/blob/542147067dd016fc5f49120ef0ba605a98a4e3a7/alacritty/src/input/keyboard.rs#L105
|
|
1876
|
+
[warp-encoder]: https://github.com/warpdotdev/warp/blob/1e6c3ae465d6a925a9b97ae03877aaadd159b8f1/crates/warp_terminal/src/model/escape_sequences.rs#L526
|
|
1877
|
+
[warp-binds]: https://github.com/warpdotdev/warp/blob/1e6c3ae465d6a925a9b97ae03877aaadd159b8f1/app/src/terminal/view/init.rs#L405
|
|
1878
|
+
[vscode-binds]: https://github.com/microsoft/vscode/blob/b04b50a28f70d834c4d039deb1d52dd3f9242293/src/vs/workbench/contrib/terminalContrib/sendSequence/browser/terminal.sendSequence.contribution.ts#L181
|
|
1879
|
+
|
|
1492
1880
|
#### Which terminals let the chords through
|
|
1493
1881
|
|
|
1494
1882
|
Each terminal's documented default key bindings, read from its source or
|
|
1495
1883
|
manual at the release named. `✗` is a chord the terminal takes for itself
|
|
1496
1884
|
by default, `~` one it takes only in a state it names, `·` one it passes on.
|
|
1497
1885
|
WT is Windows Terminal; iTerm2 and Terminal.app are on macOS, where the TUI
|
|
1498
|
-
|
|
1886
|
+
binds the ⌥ arrows alone ([Chords on macOS](#chords-on-macos)) and the
|
|
1887
|
+
other rows are for reference.
|
|
1499
1888
|
|
|
1500
1889
|
| Chord | foot | kitty | Ghostty | Alacritty | GNOME Terminal | WezTerm | Konsole | WT | iTerm2 | Terminal.app |
|
|
1501
1890
|
|---|---|---|---|---|---|---|---|---|---|---|
|
|
1891
|
+
| `Alt+K` `P` `O` `Z` `W` `E` `F`, `Alt+Shift+E` | · | · | · | · | · | · | · | · | – | – |
|
|
1892
|
+
| `Alt+1` to `9` | · | · | ~ on Linux its tabs, when the tab changes | · | ~ its tabs, with two or more | · | ~ its tabs, with two or more | · | – | – |
|
|
1893
|
+
| `Alt` arrows | · | · | · | · | · | · | · | ~ pane focus, passed on with one pane | · | ✗ `⌥←` `⌥→`, sent as the shell's word moves; `⌥↑` `⌥↓` unknown ([Chords on macOS](#chords-on-macos)) |
|
|
1502
1894
|
| `Ctrl+Alt+K` `P` `O` `Z` `W` `E` `A` `F` | · | · | · | · | · | · | · | · | · | · |
|
|
1503
1895
|
| `Ctrl+Alt+Shift+E` | · | · | · | · | · | · | · | · | · | · |
|
|
1504
1896
|
| `Ctrl+Alt+1` to `9` | · | · | · | · | · | · | · | ✗ its tabs | · | · |
|
|
1505
1897
|
| `Alt+Shift+` arrows | · | · | · | · | · | · | · | ~ pane resize, passed on with one pane | · | · |
|
|
1506
|
-
| the
|
|
1507
|
-
| kitty protocol, flags 1 and 4 | yes, since 1.10.3 | yes | yes | yes, since 0.13 | no (VTE has none) | only with `enable_kitty_keyboard` | yes, since 26.08 | yes, since 1.25 | yes | no |
|
|
1898
|
+
| the Ctrl+Shift family's `Ctrl+Shift+K` `P` `S` `M` `W` `E` `D` | · | ✗ `K` `P` `S` `W` `E` | ✗ `P` `W` `E` | · | ✗ `W` | ✗ `K` `P` `M` `W` | ✗ all seven | ✗ `K` `P` `M` `W` `D` | – | – |
|
|
1899
|
+
| kitty protocol, flags 1 and 4 (for the Ctrl+Alt and Ctrl+Shift families) | yes, since 1.10.3 | yes | yes | yes, since 0.13 | no (VTE has none) | only with `enable_kitty_keyboard` | yes, since 26.08 | yes, since 1.25 | yes | no |
|
|
1508
1900
|
| Release read | 1.28.0 | 0.49.2 | 1.3.1 | 0.17.0 | 3.60.0 (VTE 0.84.1) | 20240203 | 26.08.2 | 1.25.2733 | 3.7 | macOS 15 |
|
|
1509
1901
|
|
|
1510
|
-
Where a terminal has no protocol, its cells
|
|
1511
|
-
|
|
1512
|
-
|
|
1902
|
+
Where a terminal has no protocol, its cells for the Ctrl+Alt and
|
|
1903
|
+
Ctrl+Shift chords say only what it takes: those chords do not reach the
|
|
1904
|
+
TUI there anyway. On macOS the Alt family is not bound and there is no
|
|
1905
|
+
choice of family, hence `–`: a macOS terminal sends Option with a letter
|
|
1906
|
+
as a character unless it is set to send Option as Meta, and its arrows
|
|
1907
|
+
are in [Chords on macOS](#chords-on-macos). The three Alt rows were read from each terminal's
|
|
1908
|
+
source and manual as they stood on 2026-10-23 (their main branches), not
|
|
1909
|
+
at the releases in the last row. What the
|
|
1513
1910
|
terminals take besides, near these chords:
|
|
1514
1911
|
|
|
1515
1912
|
- Konsole: `Ctrl+Alt+S`, `N`, `M`, `U`, `H`, `G`, `I`, `0`, `[`, `]`, `\`
|
|
1516
1913
|
and `,`.
|
|
1517
|
-
- Windows Terminal: `Ctrl+Alt
|
|
1518
|
-
(pane focus).
|
|
1914
|
+
- Windows Terminal: `Ctrl+Alt+,` and `Ctrl+Alt+Left`.
|
|
1519
1915
|
- kitty: `Ctrl+Shift+Alt+T`. Ghostty: `Ctrl+Shift+Alt+J`, and `Ctrl+Alt`
|
|
1520
1916
|
with an arrow (split focus). WezTerm: `Ctrl+Shift+Alt` with an arrow,
|
|
1521
1917
|
`'` and `5`.
|
|
1522
1918
|
|
|
1523
|
-
The desktops' global keys come before any terminal's
|
|
1919
|
+
The desktops' global keys come before any terminal's. They were read
|
|
1920
|
+
for the Ctrl+Alt and Ctrl+Shift chords; "the chords above" in the last
|
|
1921
|
+
column is those, and the Alt family's were not read against them:
|
|
1524
1922
|
|
|
1525
1923
|
| Desktop (release read) | Takes, near the chords | Takes none of |
|
|
1526
1924
|
|---|---|---|
|
|
@@ -1596,10 +1994,12 @@ TUI reads the keys. The help lists its keys under The palette.
|
|
|
1596
1994
|
that can be opened is not listed.
|
|
1597
1995
|
- **The group last used comes first,** as in the Desktop's palette, and so
|
|
1598
1996
|
does the cluster, the root and the child: the one with the instance opened
|
|
1599
|
-
or shown most recently in this run first, then the
|
|
1600
|
-
sidebar keeps its own order).
|
|
1601
|
-
|
|
1602
|
-
|
|
1997
|
+
or shown most recently in this workspace in this run first, then the
|
|
1998
|
+
list's order (the sidebar keeps its own order). Each workspace keeps its
|
|
1999
|
+
own recency, its last 50 instances, so working in another leaves it as it
|
|
2000
|
+
was. When the first instance is the shown tab's, the palette opens on the
|
|
2001
|
+
instance shown before it in this workspace, wherever its group puts it
|
|
2002
|
+
(the second instance, when none was shown before): `Enter` goes back to
|
|
1603
2003
|
that terminal.
|
|
1604
2004
|
- **An instance's row** has its state mark, its name, for another machine
|
|
1605
2005
|
`on <machine>`, and, dim, its siblings as the detail names them
|
|
@@ -1632,7 +2032,9 @@ TUI reads the keys. The help lists its keys under The palette.
|
|
|
1632
2032
|
row. While the palette is open these keys are its own: they win over the
|
|
1633
2033
|
chords `Alt+Shift+Up` and `Alt+Shift+Down` ([Chords](#chords)), so they
|
|
1634
2034
|
open no agent and leave the palette open, with or without the kitty
|
|
1635
|
-
keyboard protocol. The leader then `Up` or `Down
|
|
2035
|
+
keyboard protocol. The leader then `Up` or `Down`, or `Alt+Up` or
|
|
2036
|
+
`Alt+Down` where they are chords, closes it and opens the workspace
|
|
2037
|
+
before or after. The
|
|
1636
2038
|
Desktop's palette has the same pair (`PALETTE_KEYS` in
|
|
1637
2039
|
`packages/client/keymap.mjs`, which both read).
|
|
1638
2040
|
- **On macOS there is no group key:** the Desktop's hold `⌘`, which a
|
|
@@ -1676,7 +2078,7 @@ deployments). `XDG_CONFIG_HOME` is not read for it. It never writes the file,
|
|
|
1676
2078
|
except to [move it](#the-move-from-configoats) from where earlier versions
|
|
1677
2079
|
read it. With no file the keys are the ones above. Which chord family it
|
|
1678
2080
|
binds is not here: it is `keys.json`, beside it, which the Desktop shares
|
|
1679
|
-
([Switch
|
|
2081
|
+
([Switch family](#switch-family)).
|
|
1680
2082
|
|
|
1681
2083
|
```json
|
|
1682
2084
|
{ "keys": { "quit": ["q"], "refresh": ["r", "f5"], "suspend": [] }, "ascii": false, "open": { "detachKey": "F12" } }
|
|
@@ -2035,8 +2437,8 @@ version:
|
|
|
2035
2437
|
- **A row of another machine shows what its host reported at the last
|
|
2036
2438
|
read,** not what is true at this moment. The time of that read is on the
|
|
2037
2439
|
machine's heading when it is not the time of this machine's read. A view
|
|
2038
|
-
of one machine has no heading: there the
|
|
2039
|
-
|
|
2440
|
+
of one machine has no heading: there the detail's `machine` line names the
|
|
2441
|
+
machine and the help's top row carries the time.
|
|
2040
2442
|
- The Souls and Capabilities views list a workspace of this machine's
|
|
2041
2443
|
souls and capabilities: both are this machine's.
|
|
2042
2444
|
- There is no sorting and no mouse, and a deployment's heading cannot be
|