KOSHI0.4.0
CLI
v0.4clifield manual

Discovery commands

List sessions, tabs, panes, and clients or inspect one complete record as a table or JSON.

Every list and inspect command accepts --format table or --format json. Table is the default.

List

koshi list-sessions
koshi list-sessions --remote work
koshi list-tabs --session <NAME_OR_ID>
koshi list-panes --session <NAME_OR_ID>
koshi list-clients --session <NAME_OR_ID>
CommandOutput
list-sessionsSession ids and names, and the machine each runs on
list-tabsTab ids, names, indexes, and owning sessions
list-panesPane, tab, and session ids and names
list-clientsClient ids and owning sessions

For scripts:

koshi list-panes --format json

Inspect

koshi inspect session <NAME_OR_ID>
koshi inspect tab <NAME_OR_ID>
koshi inspect pane <PANE_ID>
koshi inspect client <CLIENT_ID>

inspect prints one full record. Add --format json for machine-readable output. inspect pane shows a pane's command in full, arguments included.

The server column

list-sessions names each session's machine: local for a session on this machine, else the saved server it runs on. A bare koshi list-sessions sweeps every saved server and appends what answered. The sweep waits two seconds in total, not two seconds per server. A server that refused the saved secret, and a server that did not answer, are named on standard error and their sessions are left out. See Remote sessions.

Names and ids

Session and tab arguments take either the generated name or the printed id. An id is never re-read as a name. A name that several targets share is refused, and the error lists every matching id. Pane and client arguments take ids only.

Ending a session

koshi kill-session lives on Session commands, beside attach and detach.

Reading running state

For the whole picture — every session's tabs, panes, and clients at once, or a tab's solved rectangles — use koshi debug.

On this page