> ## 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.

# Guides overview

Amika gives you three main ways to drive rigs and agents:

1. the web UI at [https://app.amika.dev/](https://app.amika.dev/)
2. the `amika` CLI
3. the `@amika/sdk` TypeScript SDK

## Where to start

> [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.

## What you need

* An Amika account on the hosted platform at [app.amika.dev](https://app.amika.dev).
* For the CLI: install it (see [Install](https://docs.amika.dev/install.md)) and run `amika auth login`.
* For the SDK: an Amika API key from
  [app.amika.dev/settings](https://app.amika.dev/settings) and `npm install @amika/sdk`.

> [!NOTE]
>
> The SDK does not read `AMIKA_API_KEY` from your environment or disk. The
> caller is responsible for sourcing the token. The CLI handles credential
> storage for you.

## 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.