amicsdocs
CLI

Amics CLI

A standalone, provider-neutral executable for bounded remote GPU commands, durable runs, compute, and workspaces.

The amics CLI is the primary interface for people, coding agents, and CI. It ships as one executable and uses the credential saved by amics login or the AMICS_API_KEY environment variable.

Install a pinned release yourself before asking an agent to use the CLI. The versioned archive is accompanied by SHA256SUMS; verify it before placing the executable on PATH. macOS releases are Developer ID signed and notarized. Do not pipe a mutable installer into sh.

VERSION=0.2.3
TARGET=darwin-arm64 # choose the target for your OS and architecture
BASE=https://downloads.amics.ai/cli/v$VERSION
ARCHIVE=amics-$VERSION-$TARGET.tar.gz
DEST="${AMICS_CLI_INSTALL_DIR:-$HOME/.local/bin}"
curl -fsSLo "$ARCHIVE" "$BASE/$ARCHIVE"
curl -fsSLo SHA256SUMS "$BASE/SHA256SUMS"
expected=$(awk -v name="$ARCHIVE" '$2 == name { print $1 }' SHA256SUMS)
printf '%s  %s\n' "$expected" "$ARCHIVE" | shasum -a 256 -c -
tar -xzf "$ARCHIVE"
mkdir -p "$DEST"
install -m 755 amics "$DEST/amics"
rm -f "$ARCHIVE" SHA256SUMS amics
amics login
amics --help

Command map

GoalCommand
Sign inamics login
Validate the active credentialamics auth status
Revoke the active credentialamics auth logout
Diagnose local setupamics doctor
Install shell completionamics completion SHELL
Inspect live GPU optionsamics gpu recommend
Run a project commandamics run [OPTIONS] -- COMMAND
Inspect a runamics runs get RUN_ID
Read or follow logsamics runs logs RUN_ID
Cancel a runamics runs cancel RUN_ID
Stop a compute resourceamics compute stop COMPUTE_ID
Manage durable storageamics workspace ...

Authentication order

The CLI uses the first available credential:

  1. --api-key KEY
  2. AMICS_API_KEY
  3. The credential saved by amics login

Prefer AMICS_API_KEY or the saved credential. Command-line values can leak through process listings, shell history, and CI logs; use --api-key only when those arguments are private.

Global options may appear before the command or among its options. Arguments after amics run -- always remain literal.

Use --control-url only for an explicitly configured Amics environment. Normal clients use https://api.amics.ai.

Check or remove the CLI credential

amics auth status
amics auth logout

Logout revokes the active CLI key before deleting its saved copy. If the control plane is unreachable, amics auth logout --local-only removes only the local file; the remote key remains valid until separately revoked.

Run amics doctor for one setup report covering the executable, credential, control plane, agent skill, and PATH.

Install and upgrade

To upgrade, rerun the steps above with the new VERSION; the executable is replaced only after the archive checksum verifies. Set AMICS_CLI_INSTALL_DIR before running the steps to change the destination.

Supported release targets include macOS arm64/x64 and Linux arm64/x64 builds for standard glibc and x64 musl environments. Every versioned archive includes a checksum manifest; verify it before replacing the executable.

On this page