CLI reference
Complete command and option reference for the standalone amics executable.
Global
amics [global options] <command>| Option | Purpose |
|---|---|
--api-key KEY | Override AMICS_API_KEY and the saved login; avoid normal use because argv can leak into process listings, shell history, and CI logs |
--control-url URL | Override the Amics control-plane URL |
--timeout SECONDS | Request timeout; default 30 |
--help, -h | Show help |
--version, -v | Show version |
Global options may appear before the command or among its options. They are
never parsed after the literal -- separator used by amics run.
login
amics login [--no-browser]Authentication and setup
amics auth status [--json]
amics auth logout [--local-only] [--yes]
amics doctor [--json]auth logout revokes the active CLI key, then removes its matching saved copy.
--local-only skips revocation for offline recovery. doctor checks the CLI
build, credential, control plane, agent skill, and PATH.
Shell completion
amics completion bash
amics completion fish
amics completion zshRedirect the output to the completion directory used by your shell.
gpu recommend
amics gpu recommend [GPU OPTIONS] [--max-runtime DURATION]run
amics run [OPTIONS] -- COMMAND [ARG...]| Option | Purpose |
|---|---|
--project NAME | Stable project identity for compatible reuse |
--source PATH | Local source root; default . |
--compute ID | Use existing compute; it will not stop implicitly |
--workspace ID | Attach an existing durable workspace |
--max-runtime DURATION | Bound command execution |
--keep-warm DURATION | Bound post-command compute reuse |
--env NAME | Forward one local environment value; repeatable |
--detach | Return while the durable run continues |
--yes | State that explicit acquisition approval already exists |
--quiet | Exact process bytes and remote exit status |
--json | One terminal run object |
--jsonl | Structured stages and base64 output frames |
GPU options
| Option | Values |
|---|---|
--gpu FAMILY | auto or a required accelerator family |
--gpus COUNT | Positive integer; default 1 |
--min-vram GB | Minimum VRAM per GPU |
--location LOCATION | europe or united_states |
--preference MODE | balanced, cost, or speed |
--max-hourly-price USD | Maximum total compute rate |
Durations accept s, m, h, or d.
Runs and compute
amics runs get RUN_ID
amics runs logs RUN_ID [--cursor CURSOR] [--follow] [--jsonl]
amics runs cancel RUN_ID [--generation NUMBER] [--stop-compute]
amics compute stop COMPUTE_IDWorkspaces
amics workspace list
amics workspace get WORKSPACE_ID
amics workspace quote [--capacity-gb GB] [--location LOCATION]
amics workspace create --name NAME [--capacity-gb GB] [--location LOCATION]
amics workspace rename WORKSPACE_ID --name NAME
amics workspace snapshots WORKSPACE_ID
amics workspace delete WORKSPACE_ID [--yes]Exit statuses
| Status | Meaning |
|---|---|
0–255 | Remote process status, or 128 + signal, when the run result reports it |
64 | CLI validation, authentication, snapshot, or 4xx failure; no run was acquired |
70 | CLI reports a failed run with no exit code or signal |
75 | CLI reports unknown, or the control plane was unreachable |
130 | CLI reports a cancelled run |
A remote process can itself return 64, 70, 75, or 130. When a run ID
exists, inspect amics runs get RUN_ID and use its status, exit_code,
termination_signal, and failure fields before interpreting an overlapping
status. Never replay an unknown run automatically.