Skip to content
HostwrightHostwright

CLI reference

The core repository is the source of truth for command flags, JSON contracts, and exit codes. See the complete CLI reference.

Inspect and plan

Section titled “Inspect and plan”
Terminal window
hostwright --version
hostwright capabilities --json
hostwright runtime providers --json
hostwright validate hostwright.yaml
hostwright plan hostwright.yaml --output json
hostwright up hostwright.yaml --dry-run
hostwright doctor --output json

Validation and planning are local, non-mutating operations. They do not confirm that a registry image exists or that the chosen runtime can execute every requested feature.

Confirmed lifecycle

Section titled “Confirmed lifecycle”

up, down, run, start, stop, restart, rm, and update require a current dry-run plan and exact confirmation. The authenticated local daemon revalidates the manifest, plan, provider, and authority before each effect. Stale plans, missing authority, unsupported provider capabilities, and ambiguous ownership fail closed.

Terminal window
hostwright up hostwright.yaml --dry-run
hostwright up hostwright.yaml --confirm-plan <plan-hash>
hostwright status hostwright.yaml

Cleanup has its own dry-run and confirmation token. It removes only exact Hostwright-owned resources whose current state is eligible; names alone never prove ownership.

Other command groups

Section titled “Other command groups”
  • image, registry, volume, and secret manage provider-scoped local resources and evidence.
  • scheduler inspects and applies bounded local capacity decisions.
  • state, recovery, ownership, and maintenance expose durable local authority and recovery workflows.
  • daemon controls the explicit current-user service; hostwrightd can run in the foreground.
  • diagnostics support previews and creates a local privacy-safe support bundle after explicit confirmation. It never uploads automatically.
  • hostwright-dist manages verified install, upgrade, repair, rollback, and uninstall under an explicit prefix.

Use hostwright help on the installed build to see its exact command surface. Capabilities vary by build and runtime provider. Neither command help nor capability output replaces release qualification.