amicsdocs
Reference

CLI reference

Complete command and option reference for the standalone amics executable.

Global

amics [global options] <command>
OptionPurpose
--api-key KEYOverride AMICS_API_KEY and the saved login; avoid normal use because argv can leak into process listings, shell history, and CI logs
--control-url URLOverride the Amics control-plane URL
--timeout SECONDSRequest timeout; default 30
--help, -hShow help
--version, -vShow 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 zsh

Redirect 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...]
OptionPurpose
--project NAMEStable project identity for compatible reuse
--source PATHLocal source root; default .
--compute IDUse existing compute; it will not stop implicitly
--workspace IDAttach an existing durable workspace
--max-runtime DURATIONBound command execution
--keep-warm DURATIONBound post-command compute reuse
--env NAMEForward one local environment value; repeatable
--detachReturn while the durable run continues
--yesState that explicit acquisition approval already exists
--quietExact process bytes and remote exit status
--jsonOne terminal run object
--jsonlStructured stages and base64 output frames

GPU options

OptionValues
--gpu FAMILYauto or a required accelerator family
--gpus COUNTPositive integer; default 1
--min-vram GBMinimum VRAM per GPU
--location LOCATIONeurope or united_states
--preference MODEbalanced, cost, or speed
--max-hourly-price USDMaximum 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_ID

Workspaces

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

StatusMeaning
0–255Remote process status, or 128 + signal, when the run result reports it
64CLI validation, authentication, snapshot, or 4xx failure; no run was acquired
70CLI reports a failed run with no exit code or signal
75CLI reports unknown, or the control plane was unreachable
130CLI 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.

On this page