CLI reference

Discover

Command reference: discover.

Generated from the CLI catalog at fd47c2b.

guide

Agent-facing guide to airship, rendered for the caller.

airship guide [--for auto|external|orchestrator|lane] [--format md|skill|agents-md]

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

Exits: 0, 1, 2.

--host: host id. --dry-run: unsupported.

JSON schema: airship schema commands; data reference #/$defs/data_guide.

ArgumentMeaning
--foraudience (auto picks from whoami)
--formatoutput format

commands

The command catalog (machine-readable with --json).

airship commands [--all]

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

Exits: 0, 1, 2.

--host: host id. --dry-run: unsupported.

JSON schema: airship schema commands; data reference #/$defs/data_commands.

ArgumentMeaning
--allinclude runner and internal commands

help

Help for one command.

airship help [<command>]…

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

Exits: 0, 1, 2.

--host: host id. --dry-run: unsupported.

JSON schema: airship schema commands; data reference #/$defs/data_help.

ArgumentMeaning
commandcommand path, e.g. move check

schema

JSON Schemas for envelopes and outputs.

airship schema [<name>] [--raw]

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

Exits: 0, 1, 2.

--host: host id. --dry-run: unsupported.

JSON schema: airship schema commands; data reference #/$defs/data_schema.

ArgumentMeaning
nameschema name (omit to list)
--rawprint the bare schema document with no envelope

whoami

Who is calling, and what that caller may do.

airship whoami

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

Exits: 0, 1, 2.

--host: host id. --dry-run: unsupported.

JSON schema: airship schema whoami; data reference #/$defs/data_whoami.

version

Version, schema and API levels of this host.

airship version

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

Exits: 0, 1, 2, 7.

--host: host id. --dry-run: unsupported.

JSON schema: airship schema host; data reference #/$defs/data_version.

doctor

Check this host (and the mesh) for problems.

airship doctor [--mesh] [--canary] [--live] [--repair] [--strict]

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

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

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

JSON schema: airship schema check; data reference #/$defs/data_doctor.

ArgumentMeaning
--meshcheck every host reaches every other
--canarystart a throwaway stub unit end to end
--livewith --canary: use the real runtimes
--repairrebuild missing state from tmux tags
--stricttreat warnings as failures