# Amika

- [Introduction](https://docs.amika.dev/index.md): Multiplayer cloud workstations for coding agents and humans
- [Quickstart](https://docs.amika.dev/quickstart.md): Install the CLI and create your first rig.
- [Install](https://docs.amika.dev/install.md): Install the Amika CLI and SDKs.
- [Guides overview](https://docs.amika.dev/guides/overview.md)
- [What is a rig?](https://docs.amika.dev/guides/what-is-a-rig.md): Learn how Amika VM Rigs give coding agents and people a shared cloud workstation.
- [Create a rig](https://docs.amika.dev/guides/create-a-rig.md): Spin up a rig pre-loaded with your repo and agent credentials.
- [Rig lifecycle](https://docs.amika.dev/guides/rig-lifecycle.md): List, start, stop, and delete rigs.
- [Create a snapshot](https://docs.amika.dev/guides/create-a-snapshot.md): Capture a configured rig as a reusable base image so new rigs boot fast.
- [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 and read its response.
- [Manage sessions](https://docs.amika.dev/guides/manage-sessions.md): Create, list, fetch, and update agent sessions in a rig.
- [Capture agent sessions](https://docs.amika.dev/guides/capture-agent-sessions.md): Capture every Claude Code and Codex session as append-only event files on disk with amikalog.
- [Slack](https://docs.amika.dev/guides/slack.md): Drive sandboxed agents from Slack: install the app, set channel and workspace defaults, and start a conversation.
- [OpenCode](https://docs.amika.dev/guides/opencode.md): Manage the credentials that protect OpenCode web access on your rigs.
- [How configuration works](https://docs.amika.dev/guides/configuration.md): How a repository configures its rigs and agents, and how Amika resolves settings across sources.
- [config.toml reference](https://docs.amika.dev/guides/config-toml.md): Every table and key you can set in .amika/config.toml, with examples.
- [Environment variables vs. secrets](https://docs.amika.dev/guides/env-vars-and-secrets.md): When to use a plain environment variable and when to use a vault-backed secret.
- [Manage secrets and agent credentials](https://docs.amika.dev/guides/manage-secrets.md): Store API keys, OAuth credentials, and agent secrets in the Amika vault.
- [Inject credentials](https://docs.amika.dev/guides/inject-credentials.md): Wire stored secrets and agent credentials into a rig at create time.
- [Remote control agents and rigs](https://docs.amika.dev/guides/remote-control.md): Connect to Amika rigs and interact with their coding agents.
- [SSH and connect](https://docs.amika.dev/guides/ssh-and-connect.md): Open a shell on a rig over SSH, or open it in your editor.
- [Open a rig in your editor](https://docs.amika.dev/guides/open-in-editor.md): Open a running rig in Cursor, VS Code, Claude Desktop, or Codex over SSH.
- [Codex app](https://docs.amika.dev/guides/codex-app.md): Connect the Codex mobile or desktop app to an Amika rig.
- [Paseo](https://docs.amika.dev/guides/paseo.md): Install the Paseo daemon in a rig snapshot and connect from Paseo Desktop.
- [Checks](https://docs.amika.dev/guides/checks.md): Run sandboxed programs that analyze or modify your repo on every PR, locally, or in CI.
- [Code annotations](https://docs.amika.dev/guides/code-annotations.md): Annotate your code to preserve invariants, enforce rules, and inject relevant context when an agent reads or modifies specific files or code symbols.
- [Set up repo config for VM rigs](https://docs.amika.dev/guides/set-up-vm-repo-config.md): Instructions for a coding agent to inspect a local development environment and configure an Amika VM rig for the repository.
- [Programmatic usage](https://docs.amika.dev/guides/programmatic-usage.md): Script the Amika CLI to spin up a rig, drive an agent non-interactively, and ship the result.
- [MCP integrations](https://docs.amika.dev/guides/mcp-integrations.md): Give sandboxed agents pre-authenticated access to external tools via MCP servers.
- [GitHub authentication](https://docs.amika.dev/guides/github-authentication.md): How Amika authenticates to GitHub: the GitHub App, personal access tokens, and the runtime credential a rig uses for git.
- [CLI reference](https://docs.amika.dev/reference/cli.md): Commands, flags, and examples for the Amika CLI.
- [Authentication](https://docs.amika.dev/reference/auth.md): CLI login flows, credential precedence, and session storage.
- [Secrets](https://docs.amika.dev/reference/secrets.md): Scope model, generic vs provider secrets, and the secret command surface.
- [Rig environment presets](https://docs.amika.dev/reference/presets.md): Choose a prebuilt Amika environment for a rig.
- [Rig configuration](https://docs.amika.dev/reference/rig-configuration.md): Configure hosted rigs with repository settings and CLI overrides.
- [Storage paths](https://docs.amika.dev/reference/storage.md): Where Amika stores state, caches, and file-mount copies.
- [Repository configuration](https://docs.amika.dev/reference/repository-configuration.md): How .amika/config.toml configures rigs, and how settings resolve across sources.
- [config.toml](https://docs.amika.dev/reference/config-toml.md): Every .amika/config.toml key at a glance.
- [Services](https://docs.amika.dev/reference/services.md): Declare named services with port mappings and URL schemes for your rigs.
- [API reference](https://docs.amika.dev/reference/api-reference.md): Interactive docs, OpenAPI spec, and LLM context for the hosted Amika API.
- [amika-server CLI reference](https://docs.amika.dev/reference/amika-server-cli-reference.md): Commands, flags, and examples for the amika-server binary.
- [SDKs overview](https://docs.amika.dev/sdks/overview.md): Official client libraries for the Amika API.
- [TypeScript quickstart](https://docs.amika.dev/sdks/typescript/quickstart.md): Install @amika/sdk and create your first rig from TypeScript.
- [AmikaClient](https://docs.amika.dev/sdks/typescript/client.md): Method-by-method reference for the TypeScript SDK client.
- [Types](https://docs.amika.dev/sdks/typescript/types.md): Request and response interfaces for the TypeScript SDK.
- [Errors](https://docs.amika.dev/sdks/typescript/errors.md): Error classes and agent-auth detection in the TypeScript SDK.
- [Token sources](https://docs.amika.dev/sdks/typescript/token-sources.md): Supply static or dynamically-refreshed API tokens to the SDK.
- [Architecture overview](https://docs.amika.dev/architecture/overview.md): Core Amika concepts and system layout.
- [Architecture roadmap](https://docs.amika.dev/architecture/roadmap.md): Current capabilities and planned system evolution.

## Optional

- [Website](https://www.amika.dev)
- [Pricing](https://www.amika.dev/pricing)
- [GitHub](https://github.com/gofixpoint/amika)


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