CLI reference / sandbox

stado sandbox

Invocation

stado sandbox <COMMAND>

Purpose

Drive Boat sandboxes directly: create, run, read, write, fork, stop, resume and delete

Required inputs and options

This command has no command-specific inputs or options.

Output and state effect

This command group selects one of the subcommands listed below; use its exact child invocation to perform an operation.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.

Subcommands

  • fleet — Operate fleet-owned gVisor sandboxes on registered Linux bare-metal hosts
  • list — List every sandbox the key can reach, every page
  • show — Show one sandbox: its state, address and snapshot status
  • create — Create a sandbox and print it
  • exec — Run a command in a sandbox and print its exit code, signal and output; a command that does not succeed fails this one with its code. With --detach it starts in the background and its process id is printed
  • process — Follow or stop a command started with `exec --detach`
  • usage — Print what a sandbox has run and cost
  • read — Read a file from a sandbox and print Boat's answer
  • write — Write a local file into a sandbox
  • fork — Create a new sandbox from an existing one's disk
  • stop — Stop a sandbox; Boat saves its disk first and keeps it for resume or fork. With --force it stops even though that save fails
  • recover — Power-cycle the machine of a sandbox that stopped answering; its disk is not touched
  • share — Let every member of the paying organization use a sandbox; the creator's logins are wiped from it at its next start. One-way
  • resume — Resume a stopped sandbox from its saved disk
  • delete — Delete a sandbox and its data for good
  • update — Rename a sandbox, or change or clear when it stops by itself
  • prompt — Hand the coding agent in a sandbox a prompt and print the prompt run
  • prompt-status — Print a prompt run's status
  • steer — Give the running turn of a sandbox's coding agent an extra instruction; it keeps what it was doing
  • desktop — Print the URL that streams a sandbox's desktop; whoever has it sees the desktop
  • interrupt — Interrupt every conversation running in a sandbox
  • events — Print one page of a sandbox's events and the cursor of the next
  • ssh-key — Allow an OpenSSH public key into a sandbox
  • download — Download a file or folder from a sandbox into a new local file
  • file-url — Print a short-lived URL the sandbox serves for one file: a GET of it downloads the file, a PUT of the bytes writes it, with no size limit and no key. The URL is a secret until it expires
  • host — Give a port inside a sandbox a stable public HTTPS URL
  • snapshot — Save, list, show and delete named snapshots: a sandbox's disk kept under a name, from which `create --from` starts new sandboxes
  • environment — Manage environments: the variables, secret files and repositories every new sandbox started with one gets
  • conversations — Print a sandbox's agent conversations, most recently prompted first
  • history — Print one page of the commands and other processes that ran in a sandbox, newest first; also while it is stopped
  • command — Print one command of a sandbox's history
  • logs — Print a command's stored output from an offset; also while the sandbox is stopped
  • processes — Print the processes of a sandbox, busiest first, or the last sample Boat kept of a stopped one
  • ai-usage — Print the AI requests a sandbox's agents made through Boat's proxy, per day, credential and model, their tokens and cost, and whether it is blocked
  • ai-access — Let a sandbox's requests through Boat's AI proxy, or refuse them
  • webhook — Manage the account's webhooks: the HTTPS endpoints Boat posts sandbox lifecycle events to, and their signing secrets