CLI reference

Sessions

Command reference: sessions.

Generated from the CLI catalog at fd47c2b.

start

Start a managed unit in its own tmux session.

airship start [<name>] [--idle | --prompt T | --prompt-file F] [--role ROLE] [--runtime claude|codex] [--cwd DIR] [--worktree] [--base REF] [--branch B] [--tier T] [--model M] [--effort E] [--ctx-limit N|PCT] [--weight light|heavy] [--permissions ask|auto] [--tag k=v]... [--cap +cap,…] [--set key=value]... [--resume SID]

Effects: write. Agent safe: yes. Scope: auto.

Exits: 0, 1, 2, 3, 4, 6, 7, 14.

--host: host id or auto. --dry-run: accepted.

Related JSON schema: airship schema unit.

ArgumentMeaning
nameunit name (omitted: role template or role-N)
--idlewait at the runtime prompt without a framework kickoff
--roleorchestrator | lane | agent | a framework orchestrator role
--runtimeagent runtime
--cwdworking directory on the target host
--worktreenew git worktree under $AIRSHIP_HOME/worktrees
--baseworktree base ref (default: the remote's default branch)
--branchworktree branch name
--promptfirst message
--prompt-filefirst message from a file
--tierframework tier
--modelmodel id
--efforteffort level
--ctx-limitrefresh/compact point (350k, 70%)
--weightplacement weight
--permissionsstricter than the host only
--tagframework tag k=v
--capadd capabilities to an agent (+inbox,+refresh,+restart)
--setframework setting for this unit
--resumestart on an existing session id

adopt

Bring a hand-started Claude or Codex pane under management.

airship adopt <pane> [--as NAME] [--role agent|orchestrator] [--in-place | --reparent] [--wait S] [--force]

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

Related JSON schema: airship schema unit.

ArgumentMeaning
pane[host:]server:%pane
--asunit name
--rolerole after adopting
--in-placetag the pane where it is (default for agent)
--reparentresume the same session on the airship server
--waitreparent: wait up to S seconds for readiness (max 14400)
--forcereparent without waiting (loses the turn in flight)

release

Undo an in-place adopt (nothing is killed).

airship release <target>

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name

send

Type a message into a unit through the ready gate.

airship send <target> (--text T | --file F | --stdin) [--queue]

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
--textmessage text
--filemessage from a file (- = stdin)
--stdinmessage from stdin
--queueif not ready, deliver at the next ready point

upload

Copy local files to a host and print their paths there.

airship upload <file>…

Effects: write. Agent safe: yes. Scope: controller.

Exits: 0, 1, 2, 4, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
fileslocal files or directories

attach

Attach a terminal to a unit or pane (the only interactive command).

airship attach <target> [--nest]

Effects: interactive. Agent safe: no. Scope: remote.

Exits: 0, 1, 2, 4, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
--nestattach inside another tmux (TMUX unset)

stop

Kill a unit's process tree (the unit stays; restart resumes it).

airship stop <target>

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)

restart

Respawn a unit on the same session id.

airship restart <target> [--message T] [--fresh]

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
--messagesend this once ready
--freshstart a new session instead

refresh

Request a context refresh now.

airship refresh <target> [--queue]

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
--queueif the gate is closed, refresh at the next ready point

close

Archive a unit to history and remove it.

airship close <target>

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

Related JSON schema: airship schema history.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)

rename

Rename a unit.

airship rename <target> <new>

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

Related JSON schema: airship schema unit.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
newnew unit name

auto

Turn tick nudges and restarts on or off for a unit.

airship auto <target> <state>

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
stateon or off

set

Change model, effort or ctx limit of a running unit.

airship set <target> [--model M] [--effort E] [--ctx-limit N|PCT] [--apply next-restart|idle|now]

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 4, 5, 6, 7, 9.

--host: host id. --dry-run: accepted.

ArgumentMeaning
target[host:]name, or a pane ([host:]server:%pane)
--modelmodel id
--efforteffort level
--ctx-limitrefresh/compact point
--applywhen to restart for the change

history resume

Start a new unit on an archived session.

airship history resume <id> [--as NAME]

Effects: write. Agent safe: yes. Scope: remote.

Exits: 0, 1, 2, 3, 4, 6, 7.

--host: host id. --dry-run: accepted.

Related JSON schema: airship schema unit.

ArgumentMeaning
idhistory id
--asunit name (default: the original name)

history forget

Delete a history record.

airship history forget <id>

Effects: write. Agent safe: yes. Scope: local.

Exits: 0, 1, 2, 4.

--host: host id. --dry-run: accepted.

ArgumentMeaning
idhistory id

reap

Close finished oneshot units and dead agent panes into history.

airship reap [--role orchestrator|lane|agent]

Effects: write. Agent safe: yes. Scope: fanout.

Exits: 0, 1, 2, 7, 8.

--host: host id or all. --dry-run: accepted.

ArgumentMeaning
--roleonly this role