Read
Command reference: read.
Generated from the CLI catalog at fd47c2b.
status
Full view of every host.
airship status [--brief] [--watch] [--interval S]Effects: read. Agent safe: yes. Scope: fanout.
Exits: 0, 1, 2, 7, 8.
--host: host id or all. --dry-run: unsupported.
JSON schema: airship schema status; data reference #/$defs/data_status.
| Argument | Meaning |
|---|---|
--brief | only capacity and metrics (no screen captures) |
--watch | stream status events until killed |
--interval | seconds between --watch frames (min 2) |
ls
Flat unit list across hosts.
airship ls [--role orchestrator|lane|agent] [--parent UNIT] [--other] [--dead]Effects: read. Agent safe: yes. Scope: fanout.
Exits: 0, 1, 2, 7, 8.
--host: host id or all. --dry-run: unsupported.
JSON schema: airship schema unit; data reference #/$defs/data_ls.
| Argument | Meaning |
|---|---|
--role | only this role |
--parent | only units launched by this unit |
--other | include panes airship doesn't manage |
--dead | only dead and stopped units |
show
One unit in full.
airship show <target>Effects: read. Agent safe: yes. Scope: remote.
Exits: 0, 1, 2, 4, 7, 9.
--host: host id. --dry-run: unsupported.
JSON schema: airship schema unit; data reference #/$defs/data_show.
| Argument | Meaning |
|---|---|
target | [host:]name |
peek
The tail of a unit's screen.
airship peek <target> [--lines N] [--escapes]Effects: read. Agent safe: yes. Scope: remote.
Exits: 0, 1, 2, 4, 7, 9.
--host: host id. --dry-run: unsupported.
JSON schema: airship schema unit; data reference #/$defs/data_peek.
| Argument | Meaning |
|---|---|
target | [host:]name, or a pane ([host:]server:%pane) |
--lines | lines to return (max 2000) |
--escapes | keep SGR escape sequences |
transcript
Structured conversation events for a unit.
airship transcript <target> [--tail N] [--before CURSOR] [--follow] [--full EVENT_ID]Effects: read. Agent safe: yes. Scope: remote.
Exits: 0, 1, 2, 4, 7, 9.
--host: host id. --dry-run: unsupported.
JSON schema: airship schema transcript; data reference #/$defs/data_transcript.
| Argument | Meaning |
|---|---|
target | [host:]name |
--tail | last N events |
--before | page before this opaque cursor |
--follow | follow file growth until stdin closes or the session changes |
--full | one event with untruncated text and diff |
wait
Block until a unit reaches a condition.
airship wait <target> --until idle|ready|exited|needs_you|answered [--timeout S]Effects: read. Agent safe: yes. Scope: remote.
Exits: 0, 1, 2, 4, 5, 7, 9.
--host: host id. --dry-run: unsupported.
JSON schema: airship schema unit; data reference #/$defs/data_wait.
| Argument | Meaning |
|---|---|
target | [host:]name |
--until | condition |
--timeout | seconds |
history ls
Closed sessions, newest first.
airship history ls [--limit N] [--name NAME]Effects: read. Agent safe: yes. Scope: fanout.
Exits: 0, 1, 2, 7, 8.
--host: host id or all. --dry-run: unsupported.
JSON schema: airship schema history; data reference #/$defs/data_history_ls.
| Argument | Meaning |
|---|---|
--limit | how many |
--name | only this unit name |
decisions ls
The decisions inbox.
airship decisions ls [--status open|answered|all] [--asker A]Effects: read. Agent safe: yes. Scope: fanout.
Exits: 0, 1, 2, 7, 8.
--host: host id or all. --dry-run: unsupported.
JSON schema: airship schema decision; data reference #/$defs/data_decisions_ls.
| Argument | Meaning |
|---|---|
--status | which decisions |
--asker | only this asker (unit or --as label) |
decisions get
One decision (with --wait: poll until answered).
airship decisions get <id> [--wait S]Effects: read. Agent safe: yes. Scope: remote.
Exits: 0, 1, 2, 4, 5, 7, 9.
--host: host id. --dry-run: unsupported.
JSON schema: airship schema decision; data reference #/$defs/data_decisions_get.
| Argument | Meaning |
|---|---|
id | decision id |
--wait | poll every 2 s up to S seconds |
dialog
Read a unit's blocking dialog, or (operator) choose an option.
airship dialog <target> [--choose N] [--fingerprint F] [--operator]Effects: read. Agent safe: no. Scope: remote.
Exits: 0, 1, 2, 4, 5, 6, 7, 9.
--host: host id. --dry-run: accepted.
Operator only: --choose.
JSON schema: airship schema blocked; data reference #/$defs/data_dialog.
| Argument | Meaning |
|---|---|
target | [host:]name, or a pane ([host:]server:%pane) |
--choose | type option N (operator only) |
--fingerprint | the dialog fingerprint the choice was made for |
--operator | confirm an operator action from an external caller |