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.Global flags#
| Field | Type | Description |
|---|---|---|
| -o, --output | table (default), json or yaml. | |
| -a, --account <uuid> | Use another account for this one command. | |
| -q, --quiet | Suppress non-essential output. | |
| -v, --version | Print the version, commit and build date. |
auth#
| Field | Type | Description |
|---|---|---|
| auth login --token T | Check a service token and save it to the config file. --server for another API. | |
| auth logout | Clear the saved token (keeps the server URL). | |
| auth whoami | Print the user the active token belongs 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 (ws)#
| Field | Type | Description |
|---|---|---|
| ws list | List workspaces. --status, --search, --shared, --sort, --page, --limit. | |
| ws get <uuid> | Inspect one workspace and its machines. | |
| ws create | Create from --template, --base or -f. --name, --ttl, --wait, --dry-run, --public-ip. | |
| ws start <uuid> | Start a workspace. | |
| ws stop <uuid> | Stop a workspace. | |
| ws restart <uuid> | Stop, then start. | |
| ws extend <uuid> --duration 2h | Extend the TTL. | |
| ws duplicate <uuid> | Clone a workspace. --title for the copy. | |
| ws watch <uuid> | Stream workspace, machine and stack status until Ctrl-C. | |
| ws delete <uuid> | Delete a workspace. --force skips the prompt. |
machine (m)#
| Field | Type | Description |
|---|---|---|
| machine list -w <ws> | List machines in a workspace. | |
| machine get <m> -w <ws> | Inspect one machine. | |
| machine start | stop | restart <m> -w <ws> | Machine lifecycle. | |
| machine extend <m> -w <ws> --duration 1h | Extend the machine TTL. | |
| machine delete <m> | Not available from the CLI: remove one machine in the web console, or delete the whole workspace with ws delete. | |
| machine ssh <m> | Interactive SSH session through the broker. --dry-run prints the command. | |
| machine exec <m> -- <cmd> | Run a command, return its exit code. -t for a TTY. | |
| machine port-forward <m> PORT | LOCAL:REMOTE | Forward ports to localhost. Aliases forward, pf. --no-ssh for one port. | |
| machine cp <src> <dst> | Copy a file or directory; one side is <m>:/path. | |
| machine sync <src> <dst> | rsync to or from a machine. --delete, --dry-run, --exclude. | |
| machine logs <m> | Bootstrap, status and cloud-init logs. -f to follow, --source for another path. | |
| machine proxy <m> | Pipe stdin/stdout to the machine, for an ssh ProxyCommand. --port for another port. | |
| machine hostname <m> | Print the name the machine answers to over ssh. | |
| machine password <m> -w <ws> | Print the machine password. | |
| machine vm-id <m> -w <ws> | Print the underlying VM ID. |
here#
Acts on the workspace described by .easyenv/workspace.yml in the current directory or a parent.
| Field | Type | Description |
|---|---|---|
| here up | Create or reuse the project workspace. --wait 10m, --title. | |
| here watch | Stream its status until Ctrl-C. | |
| here ssh | Shell on the first machine. | |
| here sync | rsync the project onto the machine. --delete, --dry-run, --exclude. | |
| here run | Sync, then run a command there (default: make run). --cmd. | |
| here expose | Forward every port listed in workspace.yml. | |
| here down | Stop and delete the workspace. --force. |
recipe#
| Field | Type | Description |
|---|---|---|
| recipe list | List recipes. --search, --type. | |
| recipe get <name|uuid> | Inspect a recipe. |
stack#
| Field | Type | Description |
|---|---|---|
| stack list | List stack recipes (catalog of attachable services). | |
| stack get <name|uuid> | Describe a stack recipe and its variables. | |
| stack add -w <ws> --recipe <name> --var k=v | Attach a catalog stack. -m pins it to one machine; default is every matching machine. | |
| stack add -w <ws> --inline-title T --inline-runner bash --inline-file F | Attach an inline stack from a local script or playbook. | |
| stack instances -w <ws> | List stack instances on a workspace. | |
| stack apply <instance> -w <ws> | Run a stack again. -m for one machine. | |
| stack logs <instance> -w <ws> | Print the latest run log and status. | |
| stack remove <instance> -w <ws> | Remove a stack. --force skips the prompt. |
template#
| Field | Type | Description |
|---|---|---|
| template list | List workspace templates. | |
| template get <uuid> | Inspect one template, including the recipes it bundles. | |
| template use <uuid> | Create a workspace from it. --title. |
storage#
| Field | Type | Description |
|---|---|---|
| storage list | List account files. --type recipe | shared_file | artifact. | |
| storage upload <file> | Upload a file. --name, --type. | |
| storage download <uuid> | Download a file. -O for an output path. | |
| storage delete <uuid> | Delete a file. | |
| storage quota | Show usage and limit. |
ssh-key#
The public keys on your profile. A machine trusts them for your own ssh client, in every account you belong to. A machine picks the keys up when it is built, so a key you add reaches the machines you create from then on; one already running keeps the keys it booted with until it is rebuilt.
| Field | Type | Description |
|---|---|---|
| ssh-key list | Keys on your profile, with fingerprints. | |
| ssh-key add [file] | Register a public key. Defaults to your first ~/.ssh/id_*.pub. --label. | |
| ssh-key rm <uuid|fingerprint|label> | Remove a key. Running machines keep it until rebuilt. |
config#
| Field | Type | Description |
|---|---|---|
| config view | Print effective config. | |
| config set k v | Set server, default_account, output or watch_interval. | |
| config unset k | Remove a value. | |
| config path | Print the config file path. |
Misc#
| Field | Type | Description |
|---|---|---|
| status | Print the server, whether the token works, and the active account. | |
| diagnose <m> | Check the path to a machine: backend, grant, broker, port 22. | |
| completion <shell> | Print a completion script for bash, zsh, fish or powershell. |
