Skip to content

CLI Reference

Command Alias Purpose
mothership / mothership run Run the fleet
mothership clearance validate Validate the manifest (offline, no network access)
mothership preflight Validate the manifest and verify uplinks (needs network access)
mothership chart Show the routing chart
mothership init Initialize a new ship-manifest.toml
Terminal window
mothership # load ship-manifest.toml from the current directory
mothership run -c /path/to/manifest.toml
mothership --tui # TUI dashboard (requires the tui feature)
Terminal window
mothership --only web # only ships/bays tagged "web"
mothership --only web,api # multiple tags (OR logic)
mothership --except workers # everything except "workers"
Terminal window
mothership clearance # offline manifest validation
mothership clearance -c manifest.toml --verbose
mothership preflight # validation + uplink connectivity checks

preflight requires network access to the configured uplinks; if they’re only reachable from the deployment environment, use clearance locally.

Terminal window
mothership chart # print the routing table
Terminal window
mothership init # create ship-manifest.toml
mothership init --force # overwrite an existing manifest
Flag Applies to Purpose
-c <path> all Path to the manifest (default: ./ship-manifest.toml)
--tui run TUI dashboard
--only <tags> run Include only matching tags
--except <tags> run Exclude matching tags
-v, --verbose clearance, preflight Verbose output
-f, --force init Overwrite existing manifest

Requires --features tui

  • Overview tab: ship/bay status, group, PID, health, routes
  • Logs tab: per-process stdout/stderr with scroll
  • Modules tab: WASM payload status
Key Action
Tab Switch tabs
↑/↓ Navigate ships
PgUp/PgDn Scroll logs
q Quit