ix
CLI

CLI

Every command and flag, generated from the ix binary itself. The same text is in ix <command> --help and in man ix.

Machines

CommandWhat it does
ix newCreate a VM from an OCI image or a snapshot
ix lsList your VMs
ix startStart stopped VMs
ix stopStop running VMs
ix restartRestart running VMs
ix rmDelete one or more VMs
ix vmInspect VMs

Getting in

CommandWhat it does
ix shellOpen a shell in a VM
ix consoleAttach to a VM's workload console
ix serialAttach to a VM's emulated serial console (host-terminated)
ix logsView captured output from a VM

Snapshots

CommandWhat it does
ix snapshotManage VM snapshots

Networking

CommandWhat it does
ix groupManage VM east-west groups
ix netJoin a VM group's private overlay network (Linux only)

Account

CommandWhat it does
ix loginSign in through the ix website
ix meShow who you are signed in as, and against which server
ix keysMint and manage API keys: one capped key per user or per agent, over the account's single balance
ix secretStore and manage account secrets for VM provisioning
ix billingView account billing, top up, and inspect usage
ix updateUpdate the ix CLI to the latest release

Global flags

These work on every command.

FlagDescription
--message-format <MESSAGE_FORMAT>Error format One of human, short, json.

Generated from ix 2026-09-17T02:30:25Z (85a51b417d).

esc
  • Loading