Documentation
Loading...
CLI

Sandbox Status

Check whether a sandbox is live, pending, or dead

Quick health check for a sandbox. Returns whether the sandbox is live, pending, or dead, along with its fork details.

buildbear status [rpcUrl] [options]

Arguments:

ArgumentRequiredDescription
rpcUrlNoBuildBear RPC URL. If omitted, reads rpcUrl from .buildbear.json in the current directory

Options:

FlagDescription
--jsonOutput as JSON
--quietSuppress output except errors

Examples

Check sandbox using .buildbear.json:

buildbear status

Check sandbox by passing a URL:

buildbear status https://rpc.buildbear.io/my-sandbox-id

Output (human-readable):

Status:    live
Sandbox:   my-sandbox-id
Fork:      Chain 1 @ block 21000000
RPC URL:   https://rpc.buildbear.io/my-sandbox-id
Explorer:  https://explorer.buildbear.io/my-sandbox-id

Output (--json):

{
  "sandboxId": "my-sandbox-id",
  "status": "live",
  "forkingDetails": { "chainId": 1, "blockNumber": 21000000 },
  "chainId": 31337,
  "rpcUrl": "https://rpc.buildbear.io/my-sandbox-id",
  "explorerUrl": "https://explorer.buildbear.io/my-sandbox-id"
}

Status values

StatusMeaning
liveSandbox is running and accepting requests
pendingSandbox is being provisioned
deadSandbox has been deleted or timed out

The human-readable output uses color coding: green for live, yellow for pending, and red for any other state.


Use in scripts

buildbear status --json is useful for polling in scripts before running tests:

STATUS=$(buildbear status --json | jq -r '.status')
if [ "$STATUS" != "live" ]; then
  echo "Sandbox not ready: $STATUS"
  exit 1
fi