Rig lifecycle

A rig progresses through a small set of states. This guide covers each transition.

State values

State	Meaning
`initializing`	Provisioning; not yet reachable
`active`, `running`, `started`	Reachable; the SDK treats all three as “ready”
`stopped`	Paused. Can be resumed with `start`
`failed`	Provisioning or runtime failure. The wait helpers throw on this

The server may introduce new state values over time. The SDK wait helpers treat anything not in the lists above (except failed) as “still working”, so unknown values won’t break your code.

List rigs

amika rig list

const all = await amika.listRigs();
for (const sb of all) {
  console.log(sb.name, sb.state, sb.createdAt);
}

Stop a running rig

amika rig stop dev-box

await amika.stopRig("dev-box");
await amika.waitForRigStop("dev-box");

waitForRigStop polls every 3 seconds until the rig enters stopped. No client-side timeout — it throws if the rig transitions to failed.

Start a stopped rig

amika rig start dev-box

await amika.startRig("dev-box");
await amika.waitForRigStart("dev-box");

waitForRigStart polls every 3 seconds until the rig is in one of active / running / started.

Delete a rig

# Prompts for confirmation
amika rig delete dev-box

# Skip the prompt
amika rig delete dev-box --force

# Multiple at once
amika rig delete dev-box-1 dev-box-2 --force

# Also clean up volumes the rig owned
amika rig delete dev-box --force --delete-volumes

await amika.deleteRig("dev-box");

The CLI’s --delete-volumes / --keep-volumes flags control what happens to associated volumes; the SDK call always deletes the rig record and the server handles cleanup.

End-to-end example

const name = "dev-box";

// Create
await amika.createRig({ name, preset: "coder" });
await amika.waitForRig(name);

// Use it…
await amika.agentSend(name, { message: "Run the test suite" });

// Stop to pause cost
await amika.stopRig(name);
await amika.waitForRigStop(name);

// Later: resume
await amika.startRig(name);
await amika.waitForRigStart(name);

// When done
await amika.deleteRig(name);

Get started

VM Rigs

Agents and sessions

Configuration

Connecting to rigs

Code validation

Advanced

Rig lifecycle

State values

List rigs

Stop a running rig

Start a stopped rig

Delete a rig

End-to-end example

Next steps

Create a rig

SSH and connect

Rig configuration reference

​State values

​List rigs

​Stop a running rig

​Start a stopped rig

​Delete a rig

​End-to-end example

​Next steps

Create a rig

SSH and connect

Rig configuration reference

State values

List rigs

Stop a running rig

Start a stopped rig

Delete a rig

End-to-end example

Next steps