KOSHI0.6.0
v0.2quick-startfield manual

Quick start

Open a koshi session, split a pane, add a tab, detach, and come back — the whole loop in a minute.

Open a session

koshi

That gives you one tab with one shell pane. The bar at the top lists tabs; the bar at the bottom shows key hints once a shortcut is pending.

Split a pane

The default leader is Ctrl. Press the leader chord, then the direction:

KeysResult
<C-p> lOpen a pane to the right
<C-p> hOpen a pane to the left
<C-p> jOpen a pane below
<C-p> kOpen a pane above
<C-p> nOpen a pane in the configured direction

A new pane inherits the working directory of the pane you split from.

Move around and resize

KeysResult
<C-p> ←↓↑→Focus a nearby pane
<C-s> ←↓↑→Move the pane border one cell
Alt+fFill the tab with the focused pane, and back
<C-p> xClose the pane and its process tree

Add a tab

KeysResult
<C-t> nOpen a tab
Tab / Shift+TabNext / previous tab
<C-t> xClose the tab

Leave and come back

<C-q> takes your terminal out of the session. It does not end the session — every pane keeps running.

koshi list-sessions      # what is still running
koshi attach             # pick one and rejoin it

koshi detach from inside a pane does the same as the quit shortcut. See Attach and detach.

End a session for good

koshi kill-session       # the only running session

Or set auto-close-session #true in koshi.kdl to end each session once its last terminal leaves.

Get out of the way

When a program needs the keys koshi is holding, lock input with <C-l>. Every keystroke then goes straight to the program until you unlock.

See the live keymap

koshi keys list
koshi actions list

Nothing above needs a config file. When you want to change it, start at Configuration.

Start from a saved layout

Write a profile once and open the whole desk with one command:

koshi --profile dev

See Profiles.

On this page