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

# Migrating from Box

> Box is now boat, and a box is now a sandbox. Old Box API paths, keys, CLI, SDK packages and hosted URLs still work. What to change and how to know you are done.

Box became **boat** on September 15, 2026. The product, the account, the machines and the data stay the same. Two words replace the word "box":

| Word | Meaning |
| - | - |
| **boat** | The product: the site, the CLI, the API, your account and your plan. |
| **sandbox** | What you create in boat. It was a "box" before. Paths, keys, events and error codes say `sandbox`. |

Your existing Box endpoints, CLI integrations, SDK packages, environment variables and hosted URLs still work. boat has not decided the retirement policy yet. The Sunset header is a migration warning only. It is not a shutdown that boat has implemented. It is also not a promise of permanent support.

## Timeline

| Date | What happens |
| - | - |
| **2026-09-15** | boat ships. Box surfaces keep working. They now answer with `Deprecation` and `Sunset` headers. The `box` CLI prints a reminder at each run. |
| **2026-10-31** | The Sunset date that boat shows now. boat has not decided if or when legacy endpoints, binaries, packages or hosted URLs retire. The rename adds no shutdown on a date. |

## The rename in one table

| | Box (legacy compatibility) | boat |
| - | - | - |
| Dashboard | `box.ascii.dev/box/dashboard` | [`boat.dev/dashboard`](https://boat.dev/dashboard) |
| Docs | `docs.ascii.dev/box/<page>` | `docs.boat.dev/<page>` (every old URL redirects) |
| API base | `https://ascii.dev/api/box/v1` | `https://boat.dev/api/v1` |
| Resource paths | `/boxes/{boxId}` | `/sandboxes/{sandboxId}` |
| JSON keys | 14 keys, every one listed in [Every renamed name](https://docs.boat.dev/migrating-from-box/renamed-names.md#json-keys) | the same 14 with `sandbox` in place of `box` |
| Envelope `type` | 13 values, [all listed](https://docs.boat.dev/migrating-from-box/renamed-names.md#envelope-type-values) | `sandbox.` in place of `box.` |
| Error codes | 17 codes, [all listed](https://docs.boat.dev/migrating-from-box/renamed-names.md#error-code-values) | `sandbox_` in place of `box_` |
| Webhook events | 6 events: `box.ready`, `box.error`, `box.archived`, `box.hydrated`, `box.degraded`, `box.recovered` | `sandbox.` in place of `box.` |
| API keys | `box_...` | `boat_...` (keys you already have stay valid) |
| Org header | `X-Box-Org` | `X-Boat-Org` |
| CLI | `box`, `box-dev` | `boat`, `boat-dev` |
| CLI env vars | 20 variables, [all listed](https://docs.boat.dev/migrating-from-box/renamed-names.md#cli-environment-variables) | `BOAT_` in place of `BOX_` |
| CLI config | `~/.config/ascii/box/config.json` | `~/.config/ascii/boat/config.json` |
| Snapshot ignore file | `.boxignore` | `.boatignore` |
| Hosted URLs | `https://<label>.on.ascii.dev` | `https://<label>.on.boat.dev` (same route, same token, both answer) |
| Inside a sandbox | `box` CLI, `BOX_ID`, `BOX_CURRENT_ID` | `boat` CLI, `BOAT_ID`, `BOAT_CURRENT_ID` (both spellings exported) |
| Python SDK | `ascii-box-sdk` / `ascii_box_sdk` | `boat-sdk` / `boat_sdk` |
| TypeScript SDK | `@asciidev/box-sdk` | `@boatdev/sdk` |
| Other languages | `ascii_box_sdk`, `github.com/ascii-dev/box-go-sdk` | No boat package yet. Generate a client from [`/openapi/boat-v1.yaml`](https://docs.boat.dev/openapi/boat-v1.yaml). |
| Integrations | `harbor-box`, `@asciidev/eve-box` | Same packages. They still call the Box API. See [Harbor](https://docs.boat.dev/integrations/harbor.md) and [Eve](https://docs.boat.dev/integrations/eve.md). |

These items do not change:

* IDs (`bx_...`) and snapshot IDs.
* The `X-Ascii-*` headers (`X-Ascii-Confirm-Delete` and the webhook headers) and `Idempotency-Key`. They are the current names.
* `sandboxId` on API keys. It already said sandbox.
* All of your data.

## Am I done?

Check each item:

* Your API client logs show no `Sunset` header.
* Your scripts do not call a `box` binary. The reminder line no longer shows.
* `pip show ascii-box-sdk` and `npm ls @asciidev/box-sdk` return nothing.
* `GET /api/v1/webhooks` lists webhooks with `sandbox.*` events.
* Your published links say `on.boat.dev`.

## Retirement policy

boat currently keeps these legacy items:

* The legacy API routes.
* The binary and environment aliases.
* The hosted addresses.

The October 31 header does not cause a `410 Gone`. It does not disable installed clients. It does not remove DNS. boat must still make an explicit policy decision on the scope and time of a future retirement. This guide does not promise a shutdown on that date. It also does not promise permanent support.

Questions: see [Support](https://docs.boat.dev/support.md).

## Learn more

> [card] [Migration steps](https://docs.boat.dev/migrating-from-box/steps.md)
>
> What to change in the CLI, the SDKs, raw HTTP, webhooks, hosted URLs and inside a sandbox.

> [card] [Every renamed name](https://docs.boat.dev/migrating-from-box/renamed-names.md)
>
> The full list of renamed paths, keys, types, codes, events, variables, headers and files.


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