Command reference
A flat list of every easyenv command. Use it as a cheat sheet alongside the per-command --help output.
The CLI is self-documenting
Every command supports
--help. The lists below are a quick reference; easyenv workspace create --help always has the authoritative flag set. The easyenv-cli README is the canonical source for new commands and breaking changes.auth#
| Field | Type | Description |
|---|---|---|
| auth login --token T | Save a service token to the keychain. | |
| auth logout | Forget the saved token. | |
| auth whoami | Print the user and account the active token resolves to. | |
| auth token | Print the saved token (for piping into curl, etc.). |
account#
| Field | Type | Description |
|---|---|---|
| account list | List accounts you belong to. | |
| account use <uuid> | Set the active account. | |
| account current | Print the active account. |
workspace#
| Field | Type | Description |
|---|---|---|
| workspace list | List workspaces in the active account. | |
| workspace get <id> | Inspect one workspace. | |
| workspace create [...] | Provision a new workspace. | |
| workspace stop <id> | Pause a workspace, keeping its disks. | |
| workspace resume <id> | Bring a stopped workspace back. | |
| workspace delete <id> | Permanently delete a workspace. | |
| workspace ssh <id> | SSH into the first (or named) machine. |
machine#
| Field | Type | Description |
|---|---|---|
| machine list | List machines (filterable by --workspace). | |
| machine restart <id> | Reboot a machine. | |
| machine logs <id> | Stream cloud-init and Ansible logs. | |
| machine forward <id> P | Forward a remote port to localhost. | |
| machine cp src dst | Copy files to or from a machine. |
recipe#
| Field | Type | Description |
|---|---|---|
| recipe list | List recipes available to the account. | |
| recipe get <id> | Inspect a recipe. |
stack#
| Field | Type | Description |
|---|---|---|
| stack list | List stack-recipes (catalog of attachable services). | |
| stack add -w <ws> -m <m> --recipe <name> --var k=v | Attach a catalog stack to a machine. | |
| stack add -w <ws> -m <m> --inline-* | Attach an inline (custom) stack from a local script. | |
| stack remove <id> | Detach a stack from a machine. |
template#
| Field | Type | Description |
|---|---|---|
| template list | List saved templates. | |
| template get <id> | Inspect one template, including the recipes it bundles. |
config#
| Field | Type | Description |
|---|---|---|
| config view | Print effective config. | |
| config set k v | Set a value in the config file. | |
| config unset k | Remove a value. | |
| config path | Print the config file path. |
Misc#
| Field | Type | Description |
|---|---|---|
| status | Print server, account, plan, and recent workspaces. | |
| completion <shell> | Print a shell completion script. | |
| diagnose | Run a self-check (network reachability, token validity, etc.). | |
| --version | Print the binary version and git SHA. |