CLI

The groundbox command covers sandboxes and CI. Every command takes --json and then prints one JSON value; groundbox --help lists every command and exit code.

export GROUNDBOX_API_KEY=gbx_...          # or: groundbox login
id=$(groundbox sandbox create --json | jq -r .id)
groundbox sandbox exec $id -- git clone https://github.com/acme/app
groundbox sandbox exec $id -- 'cd app && npm ci && npm test'
copy=$(groundbox fork $id --json | jq -r .id)
groundbox sandbox rm $id $copy

Sign in

groundbox login opens a browser page where you approve this machine, then saves the key. When GROUNDBOX_API_KEY is set it is used as is and nothing is saved.

Commands

  • login, logout, whoami
  • sandbox create | list | get | exec | shell | cp | fork | pause | resume | extend | rm | usage
  • run -- <command> starts a sandbox, runs the command in it and deletes it.
  • fork <sbx_id> is short for sandbox fork.
  • ci wait exits 0 when CI passed, 1 when it failed (and prints the failing step's log) and 4 when it timed out.
  • migrate github|blacksmith|depot|namespace [--dry-run] rewrites runs-on in your workflow files.

Create an account and get an API key.