> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amika.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install the CLI and create your first rig.

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](https://app.amika.dev/signup) and follow onboarding.

## Step 2: Set up the CLI

1. Download the CLI

   ```bash theme={null}
   curl -fsSL https://raw.githubusercontent.com/gofixpoint/amika/main/install.sh | sh
   ```

2. Login, and sync your Claude and/or Codex credentials

   ```bash theme={null}
   amika auth login
   amika secret codex push --type oauth --name "Codex Subscription"
   amika secret claude push --type oauth --name "Claude Subscription"
   ```

## 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/](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:

```bash theme={null}
# make sure you uploaded an SSH key
amika secret ssh-keygen

cd path/to/git/repo/you/want/to/work/on
amika rig create --name my-first-rig
amika rig ssh my-first-rig
```

This spins up a rig, pre-loaded with your Git repo and agent credentials. List your rigs with:

```bash theme={null}
amika rig list
```

### Create an agent chat session

```bash theme={null}
cd path/to/git/repo/you/want/to/work/on
amika send --agent codex "What does this repo do?"
```

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:

```bash theme={null}
amika session list
```

## Make an API key

To use Amika programmatically, you can generate an API key. Either go to [https://app.amika.dev/settings/api-keys](https://app.amika.dev/settings/api-keys) or after logging into the `amika` CLI, run `amika auth api-key create --help` and then create and store a key.

## Next steps

> [card] [Create a rig](https://docs.amika.dev/guides/create-a-rig.md)
>
> Spin up a rig loaded with your repo and agent credentials.

> [card] [Send a message to an agent](https://docs.amika.dev/guides/send-a-message-to-an-agent.md)
>
> Run Claude, Codex, or another agent inside a rig synchronously.

> [card] [Rig and repository configuration](https://docs.amika.dev/guides/configuration.md)
>
> Each rig boots from a repository, whose `.amika/config.toml` configures the rig and agents.

> [card] [Remote control agents and rigs](https://docs.amika.dev/guides/remote-control.md)
>
> Remote-control agents and rigs from Slack, Linear, the Codex app, or SSH.

## See also

> [card] [CLI reference](https://docs.amika.dev/reference/cli.md)
>
> Full flag listing for every `amika` command.

> [card] [TypeScript SDK](https://docs.amika.dev/sdks/typescript/quickstart.md)
>
> Method-by-method reference, types, and errors.

> [card] [HTTP API](https://docs.amika.dev/reference/api-reference.md)
>
> Interactive docs and OpenAPI spec for the hosted API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.