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

# Quickstart

> Install the boat CLI on macOS, Linux or Windows, start a cloud sandbox, and run a command in it. Or do the same from Python, TypeScript or curl.

boat gives you full Ubuntu virtual machines (sandboxes) for AI agents and code, billed per second. Start one in two minutes.

## 1. Install the CLI

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

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

```powershell Windows theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
irm https://boat.dev/install.ps1 | iex
```

The installer does these steps:

1. It opens your browser to sign you in. Use GitHub, Google, or a code that boat sends by email.
2. It asks if the sandboxes are for you or for your users.
3. It opens checkout for a plan. Your first plan starts with a 7-day [free trial](https://docs.boat.dev/free-trial.md). A card is required.

Then **open a new terminal**. The installer adds a shell function, and only a new terminal loads it.

## 2. Start a sandbox

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
boat new
```

`boat new` prints the id of the sandbox, for example `bx_23456789`.

| Property | Value |
| - | - |
| Type | Full Linux virtual machine (Ubuntu) |
| Size | `default`: 4 vCPU, 8 GB. Read [Pricing](https://docs.boat.dev/pricing.md) for the other sizes. |
| Installed | Docker, Node, Python, Go, Rust and the usual coding agents |
| Auto-stop | After one hour, unless you set a different time |

## 3. Use it

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
boat exec bx_23456789 "echo hello"   # run a command, get its output
boat ssh bx_23456789                 # open a shell inside
boat stop bx_23456789                # take a snapshot and stop billing
boat resume bx_23456789              # bring it back
```

* Instead of the id, you can type `current`. It means the last sandbox that you created or forked in this terminal.
* Without an id, `boat ssh` and `boat exec` also use `current`.

### Run a coding agent

`boat prompt` runs Claude Code, Codex or another [integrated agent](https://docs.boat.dev/integrated-agents.md) inside the sandbox. **Connect an AI key or subscription first.** Read [Keys and subscriptions](https://docs.boat.dev/integrated-agents/keys.md). Without one, the prompt fails with `provider_not_configured`.

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
boat prompt bx_23456789 "add tests"
```

> [card] [Integrated agents](https://docs.boat.dev/integrated-agents.md)
>
> Claude Code, Codex and the other agents you can prompt in a sandbox.

> [card] [Connect a key or subscription first](https://docs.boat.dev/integrated-agents/keys.md)
>
> Add an AI key, or sign in with a subscription, before your first prompt.

> [card] [Run an agent on your repo](https://docs.boat.dev/recipes/agent-on-repo.md)
>
> Clone a repository and let an agent work on it.

> [card] [Run agents in parallel](https://docs.boat.dev/recipes/parallel-agents.md)
>
> Fork one sandbox into many and prompt each one.

## From code

1. Install the SDK, or use curl:

   ```bash Python theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
   python -m pip install boat-sdk
   ```

   ```bash TypeScript theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
   npm install @boatdev/sdk
   ```

2. Create an [API key](https://docs.boat.dev/api-keys). The `ci` preset can create, use and delete sandboxes:

   ```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
   boat api-key create my-app --preset ci
   export BOAT_API_KEY=boat_...        # the secret that the command prints once
   export BOAT_API_BASE=https://boat.dev/api/v1
   ```

3. Create a sandbox and run a command in it:

```bash curl theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
id=$(curl -sS -X POST "$BOAT_API_BASE/sandboxes" \
  -H "Authorization: Bearer $BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ttlSeconds":3600}' | jq -r .sandbox.id)

curl -sS -X POST "$BOAT_API_BASE/sandboxes/$id/commands" \
  -H "Authorization: Bearer $BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command":"echo hello"}'
```

```ts TypeScript theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
import { BoatApi, Configuration, waitUntilReady, execCommand } from "@boatdev/sdk";

const boat = new BoatApi(new Configuration({
  basePath: "https://boat.dev/api/v1",
  accessToken: process.env.BOAT_API_KEY!,
}));

const created = await boat.create({ ttlSeconds: 3600 });
const id = created.sandbox.id;
await waitUntilReady(boat, id);
const result = await execCommand(boat, id, "echo hello");
console.log(result.stdout);
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
import os
from boat_sdk import ApiClient, Configuration, wait_until_ready, exec_command
from boat_sdk.api.boat_api import BoatApi
from boat_sdk.models.create_sandbox_request import CreateSandboxRequest

config = Configuration(host="https://boat.dev/api/v1", access_token=os.environ["BOAT_API_KEY"])
with ApiClient(config) as client:
    boat = BoatApi(client)
    created = boat.create(create_sandbox_request=CreateSandboxRequest(ttl_seconds=3600))
    sandbox_id = created.sandbox.id
    wait_until_ready(boat, sandbox_id)
    result = exec_command(boat, sandbox_id, "echo hello")
    print(result.actual_instance.stdout)
```

`boat` in the code is the API client, not a sandbox. A command that waits for its result stops after 30 seconds by default. For longer work, read [Background commands](https://docs.boat.dev/long-running-tasks/background-commands.md).

## Next

> [card] [Pricing](https://docs.boat.dev/pricing.md)
>
> The cost per hour of each size, and what a plan gives you.

> [card] [Integrated agents](https://docs.boat.dev/integrated-agents.md)
>
> Run Claude Code, Codex and other agents in a sandbox.

> [card] [Environments](https://docs.boat.dev/environments.md)
>
> The repositories, secrets and credentials that each new sandbox starts with.

> [card] [Keep a sandbox running](https://docs.boat.dev/long-running-tasks.md)
>
> Keep a sandbox up for days. Resume and fork it.

> [card] [Sandbox per user](https://docs.boat.dev/platform-guide)
>
> Give each user or agent a sandbox of their own.

> [card] [API and SDKs](https://docs.boat.dev/api/v1.md)
>
> Auth, envelopes, errors, and the typed Python and TypeScript clients.

> [card] [Docs for AI agents](https://docs.boat.dev/ai-tools.md)
>
> Give your coding agent these docs: llms.txt, Markdown pages and skills.

> [card] [Limits and errors](https://docs.boat.dev/limits.md)
>
> Every limit per plan, the error codes, and how to raise a limit.


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