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

# Sparkles documentation

> Run local coding agents with Sparkles or create managed coding sandboxes through the API.

Sparkles gives teams a shared interface for local coding agents, cloud sandboxes, and connected developer tools. Use these docs to install the CLI or build a Sandbox API integration.

## Run a local agent

The Sparkles CLI runs Claude Code, Codex, or OpenCode on your computer using the agent access you already have. Sessions can stay local, mirror to the Sparkles dashboard, or hand off to a cloud sandbox.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -fsSL https://sparkles.dev/install | sh
sparkles
```

Start with [Install the CLI](/cli/install), then learn how to choose an [agent, model, and reasoning effort](/cli/models-and-effort) from the terminal UI.

## Build a Sandbox API integration

Every Sparkles user can create and control managed coding sandboxes through the API.

The production base URL is `https://sparkles.dev`. Every API request uses HTTPS and a bearer key created from the [API access page](https://sparkles.dev/api).

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
Authorization: Bearer $SPARKLES_API_KEY
```

API keys begin with `spk_live_` in production. Sparkles shows a key only once, stores only its SHA-256 digest, and rejects it immediately after either the key or its access grant is revoked.

Follow the [sandbox quickstart](/sandboxes-quickstart) to create, stream, prompt, and terminate a sandbox. Then review the [sandbox resource lifecycle](/sandboxes), [stream event contract](/sandbox-events), and [error and retry behavior](/errors).

The [OpenAPI reference](/openapi.json) contains the machine-readable request and response contracts.

## Choose a path

| Goal                                        | Start here                                            |
| ------------------------------------------- | ----------------------------------------------------- |
| Install and run a local coding agent        | [CLI installation](/cli/install)                      |
| Change the active harness, model, or effort | [Models and reasoning effort](/cli/models-and-effort) |
| Configure a repository or automated run     | [CLI configuration](/cli/configuration)               |
| Create and control managed cloud sandboxes  | [Sandbox API quickstart](/sandboxes-quickstart)       |
| Maintain CLI release channels               | [CLI release process](/cli/release-process)           |