Skip to main content
The sail CLI manages Sailboxes and apps from the terminal. It is a single binary with no runtime dependencies.

Install

Installs the latest sail into ~/.sail/bin. If that directory is not on your PATH, the installer adds it to your shell startup files and prints the line to run in the current shell.
SAIL_HOME relocates sail’s home directory, and SAIL_INSTALL_DIR installs a copy at an exact path for provisioning scripts.

Authenticate

Every command reads SAIL_API_KEY, falling back to the credential stored by sail auth login. If the stored key is still valid and tied to your own account, sail auth login reports that login and returns without opening the browser. To log in as a different organization or user, run sail auth logout first. A key passed with --api-key or piped to stdin always replaces the stored key.

Interactive Shell

For interactive use, sail shell is the most convenient option. It opens a REPL on your machine that accepts every command below without the leading sail (so box list, box create ...), and adds features the one-shot commands lack: line editing and history, a picker menu when you omit a Sailbox id, and confirmation prompts.
The individual sail <command> subcommands take their arguments up front, which suits scripts and agents (add --json for machine-readable output).
sail shell manages Sailboxes from your machine. To open a terminal inside a Sailbox, use sail box shell <id>.

sail box shell

sail box shell <id> opens a terminal inside the Sailbox without exposing a port. While connected, it forwards browser opens, localhost services, and clipboard interactions to your machine. Pass --no-forward to disable this. sail box exec --tty uses the same forwarding and accepts the same flag. See shell for details.

Sailbox lifecycle

Checkpoints

sail checkpoint list shows the checkpoints a Sailbox can still be started from. sail checkpoint delete makes a checkpoint unusable for new Sailboxes; Sailboxes already started from it keep running.

Image builds

sail image-build list shows one page of your organization’s image builds. --status keeps only builds in that status: queued, building, ready, failed, or cancelled. Repeat it or separate statuses with commas to match any of several. See Build queue for when a build is queued and for your organization’s build limit. sail image-build cancel stops a build that is queued or building. Anything waiting on that build fails with “image build was cancelled”. A build that has already finished cannot be cancelled.

Cron jobs

sail box cron runs a shell command in a Sailbox on a schedule, waking the Sailbox when a run is due.
See Run a command on a schedule for the schedule format and how runs behave.

Custom domains

sail box domain serves a Sailbox HTTP listener on a hostname you own, with TLS certificates obtained and renewed for you.
attach requires --port naming an exposed HTTP listener, and checks that your DNS record points at your target first. See Custom domains for the DNS setup, apex-domain options, and certificate behavior.

SSH

sail box ssh sets up SSH access so you can reach a box as ssh <name>.sail. For a quick interactive shell, prefer sail box shell: it does not need an open port. Use SSH when you need a real SSH endpoint rather than a PTY over exec, such as for scp/rsync, an editor’s remote mode, or a devbox you work in day to day. Enabling it exposes port 22 as a TCP ingress port, which counts against your org’s raw endpoint limit.
  • enable: turn on SSH for a box (expose port 22, install your org’s CA, start sshd), certify your key on this machine, and add the <name>.sail shortcut. --allowlist <addr> restricts the sources allowed to reach port 22 to an address or a range (repeatable). Passing --allowlist replaces the port’s current restriction. Omitting it on a first enable leaves port 22 open to any source. On a re-enable it keeps the existing restriction.
  • alias: add ssh <name>.sail shortcuts for boxes already SSH-enabled elsewhere (e.g. from the SDK), without waking them.
  • disable: stop SSH on a box and drop its local shortcut.
Only the public half of your key is certified. The private key is referenced in your SSH config, never read.