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

# Accounts and sign-in

> Sign-in methods, reinstalling or using a second computer, and which surface (CLI, API, SDKs, dashboard) does what.

## Sign-in methods

There are four ways to sign in, on the CLI and on the [dashboard](https://boat.dev/dashboard):

* GitHub
* Google
* A 6-digit code sent by email
* [AgentID](https://agentid.com), for an AI agent that has its own AgentMail inbox. See [Sign up from an agent](https://docs.boat.dev/agent-auth.md#sign-in-with-agentid).

No method is more correct than the others. Use the one you like. You can add the others later.

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
boat login                          # asks: github, google, email, or agentid
boat login --google
boat login --email you@example.com
boat login --agentid
```

Each method that you use is a **connection** on your account. [Dashboard > Account](https://boat.dev/dashboard?tab=account) lists them.

* All connections open the same account, with the same sandboxes, settings and billing.
* You can add or remove connections at any time. One connection must remain.
* The **primary** connection sets the address that gets account notifications. To change that address, make a different connection primary.

> [!NOTE]
>
> A sign-in with a method that is not connected yet makes a **separate** account. This is true also when the email address is the same. To add a second method to your account, do these steps:
>
> 1. Sign in with your usual method.
> 2. Add the connection from the Account tab.
>
> To move a connection between two existing accounts, you must merge the accounts. Only support can do a merge.

A sign-in with Google, email or AgentID does not give boat access to your code. To clone [repositories](https://docs.boat.dev/environments/repositories.md), you need a GitHub connection. You can add it when you first need it.

## Reinstalling, or a second computer

Your plan, environment, sandboxes and settings are on your account, not on your computer. To reinstall boat, or to install it on a new computer, sign in on that computer:

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
boat onboard   # or: boat login
```

Sign in with the same method as the first time. `boat onboard` then finds your account:

* It skips each step that your account has already done.
* It does **not** open Stripe Checkout when your plan is active.

> [!NOTE]
>
> Use the same sign-in method as before. A method that was never connected to your account opens a **separate** account, with its own empty plan. This is the usual cause when a reinstall asks you to subscribe again.

## What the sandboxes are for

Onboarding asks what the sandboxes are for. There are two answers:

* Your own work.
* A platform of yours, used by third-party users. This is the default.

The second answer marks your environment [safe for third parties](https://docs.boat.dev/environments.md#safe-for-third-parties). Then none of your credentials go to those sandboxes.

You can change this at any time in [Dashboard > Environment](https://boat.dev/dashboard?tab=environment).

## Four ways to drive boat

The four ways use the same platform. The code examples in these docs have **CLI**, **curl**, **TypeScript** and **Python** tabs. Select a tab one time, and the rest of the page uses it.

| | Use it for | Auth |
| - | - | - |
| **CLI** (`boat`) | your terminal, CI jobs, shell scripts, and from inside a sandbox | browser sign-in or `BOAT_API_KEY` |
| **REST API** | any language, webhooks, anything the SDKs do not cover yet | `BOAT_API_KEY` |
| **SDKs** ([Python](https://docs.boat.dev/sdks/python.md), [TypeScript](https://docs.boat.dev/sdks/typescript.md)) | typed calls from your own service | `BOAT_API_KEY` |
| **[Dashboard](https://boat.dev/dashboard)** | one-off work, and the things that must not be automatable | browser sign-in |

The four ways are not identical. The differences are intentional:

| Only in the dashboard | Only in the CLI | Only in the API and SDKs |
| - | - | - |
| [Webhook delivery history](https://docs.boat.dev/webhooks.md), removing [organization members](https://docs.boat.dev/organizations.md#members-and-invites), member roles and per-member caps, sign-in connections, per-sandbox metrics, [closing your account](https://docs.boat.dev/data-retention/close-account.md) | interactive SSH, SCP, port forwarding, `boat snapshot pull` | editing a webhook in place (`PATCH /webhooks/{webhookId}`), reading and writing files in a sandbox without SSH |

Invites work from the CLI too: `boat org invite`. Read [Organizations](https://docs.boat.dev/organizations.md#members-and-invites).

Some actions need a browser sign-in, on the CLI or on the dashboard. boat refuses them to an API key on purpose:

* Rotate and revoke [API keys](https://docs.boat.dev/api-keys).
* Turn on [zero data retention](https://docs.boat.dev/data-retention).

To create an API key, use a browser sign-in, or an API key with the `admin` preset. A new key never gets more rights than the key that creates it.

An agent can also sign itself in and claim a human. See [Sign up from an agent](https://docs.boat.dev/agent-auth.md).


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