cli

the cli

the reference below renders the same text the binary carries: what you read here is what --help and man ix print. every command holds one contract: stdout is data, stderr is progress, exit codes tell the truth. listings take --output json.

Bare ix opens the interactive dashboard: browse your VMs, see their state and usage, and shell into one. The commands below do the same jobs scriptably; default-command in the CLI config can rebind bare ix.

commands

  • ix open the interactive dashboard
  • ix apply Converge VMs on a project's configuration
  • ix new Create a VM from a template, a snapshot, or a flake
  • ix init Create a minimal ix project in the current directory
  • ix ls List your VMs
  • ix start Start stopped VMs
  • ix stop Stop running VMs
  • ix restart Restart running VMs
  • ix templates Manage the region's templates
  • ix shell Open a shell in a VM
  • ix console Attach to a VM's workload console
  • ix serial Attach to a VM's emulated serial console (host-terminated)
  • ix net Join a VM group's private overlay network (Linux only)
  • ix logs View captured output from a VM
  • ix vm Inspect VMs
  • ix snapshot Manage VM snapshots
  • ix rm Delete one or more VMs
  • ix group Manage VM east-west groups
  • ix keys Mint and manage API keys: one capped key per user or per agent, over the account's single balance
  • ix secret Store and manage account secrets for VM provisioning
  • ix billing View account billing, top up, and inspect usage
  • ix login Sign in through the ix website
  • ix me Show who you are signed in as, and against which server
  • ix update Update the ix CLI to the latest release