Skip to main content
This quickstart walks you through a minimal Amika flow:
  1. Log into Amika.
  2. Install the CLI.
  3. Create a rig and message a sandboxed agent from the CLI.
    1. You can also use the web UI or the TypeScript SDK.

​
Prerequisites

  • macOS or Linux

​
Step 1: Sign up

Sign up at https://app.amika.dev/signup and follow onboarding.

​
Step 2: Set up the CLI

  1. Download the CLI
  2. Login, and sync your Claude and/or Codex credentials

​
Step 3: Create rigs and message agents

Now, you can either (a) create a rig and then connect to it however you choose, or (b) directly start an agent chat session, which will provision its own rig behind the scenes. Both can be done from the https://app.amika.dev/, and also from the CLI.

​
Create a rig

If you want to create a rig and then chat with it from Codex, Cursor, OpenCode, SSH, etc., you can create a rig without first making an agent session. Assuming you connected GitHub during web onboarding:
This spins up a rig, pre-loaded with your Git repo and agent credentials. List your rigs with:

​
Create an agent chat session

This will spin up a rig in the background and send the message to a Codex agent on the rig. You can list agent sessions with:

​
Self-hosting

If you want to self-host, read the self-hosting guide.

​
Next steps

Create a rig

Spin up a rig loaded with your repo and agent credentials.

Send a message to an agent

Run Claude, Codex, or another agent inside a rig synchronously.

Rig and repository configuration

Each rig boots from a repository, whose .amika/config.toml configures the rig and agents.

Remote control agents and rigs

Remote-control agents and rigs from Slack, Linear, the Codex app, or SSH.

​
See also

CLI reference

Full flag listing for every amika command.

TypeScript SDK

Method-by-method reference, types, and errors.

HTTP API

Interactive docs and OpenAPI spec for the hosted API.