Skip to main content
Do the steps that apply to you. For the full list of renamed names, read Every renamed name.

​
1. CLI

Install the boat CLI:
You stay signed in. boat reads the config that box wrote. Then do these steps:
  1. In scripts and CI, replace box with boat. Subcommands do not change: boat new, boat list, boat ssh.
  2. Rename BOX_* variables to BOAT_*. Now, if a BOAT_* variable is not set, Boat uses its BOX_* twin. It then prints a one-line notice on stderr.
  3. Rename .boxignore files to .boatignore. Boat reads both files now. If a directory has both, .boatignore wins.
  4. Change boat api-key create --box bx_1 to --sandbox bx_1.
The final compatibility release of box prints a migration reminder. Use boat to get later updates. No date check disables legacy binaries.

​
2. SDKs

Replace the package:
Then change your code: The helpers keep their names: In Python, pass the request body by keyword: boat.create(create_sandbox_request=CreateSandboxRequest(...)). See Python SDK. To change the types and keys, do a whole-word search and replace: Then make two changes by hand: the package import, and BoxApi to BoatApi.

​
3. Raw HTTP

Responses use the new words: sandbox / sandboxes / sandboxId, type: "sandbox.created", code: "sandbox_not_found". Request bodies also use the new keys, for example passSandboxCredentials and sourceSandboxId. A request to /api/box/* answers in box words now. It has these headers:
If your client logs response headers, search the logs for Sunset. Each match is a call that you did not move yet.

​
4. Webhooks

Webhooks that you created before the rename still send box.* events with payloads that say box. Signatures, headers and retries do not change. To move a webhook:
  1. Create it again through the Boat API, or with boat webhook create.
  2. Delete the old webhook.
The new webhook sends sandbox.* events and X-Ascii-Event: sandbox.ready. There are 6 events: ready, error, archived (stopped), hydrated, degraded and recovered.

​
5. Hosted URLs

Each hosted route answers on two addresses, with the same _token:
  • https://<label>.on.ascii.dev
  • https://<label>.on.boat.dev
Update the links that you published or embedded to the on.boat.dev form. Boat has not decided the retirement policy for the on.ascii.dev form.

​
6. Inside a sandbox

  • The boat CLI is on the PATH of each sandbox. box still points to it.
  • Boat exports BOAT_ID, BOAT_CURRENT_ID and BOAT_CLI_* next to their BOX_* twins.
  • Agent skills use the boat skill. Boat removes a box skill directory at the next start.