Skip to content

EN Get Started First Sandbox

lkmavi edited this page Sep 24, 2026 · 1 revision

First sandbox

Requires a running compute provider and usually a selected gateway (Install).

Create

whaleshell sandbox create \
  --name demo \
  --workspace "$PWD" \
  --policy whaleshell-cli/policies/default.yaml \
  --memory 2g
Flag Role
--name Sandbox id (whaleshell-<name> container)
--workspace Host path bind-mounted at /workspace
--policy Base policy YAML
--memory Soft recommendation on Desktop; optional

Image defaults to the local base sandbox unless --from / --image is set.

Exec and connect

whaleshell sandbox list
whaleshell sandbox status demo
whaleshell sandbox exec demo -- uname -a
whaleshell sandbox connect demo          # bash -il

Stop, start, delete

whaleshell sandbox stop demo
whaleshell sandbox start demo
whaleshell sandbox delete demo

Delete removes the sandbox container, proxy sidecar, network, and labeled data volumes. Gateway provider secrets remain until you delete the provider or wipe gateway data.

With credentials

GITHUB_TOKEN=… whaleshell provider create --name gh --type github --credential GITHUB_TOKEN

whaleshell sandbox create \
  --name demo \
  --workspace "$PWD" \
  --policy whaleshell-cli/policies/default.yaml \
  --provider gh \
  --memory 2g

See Credential providers and Cursor agent.

Observe

whaleshell logs demo --tail --source proxy
whaleshell term

Next

→ New docs site

whaleshell

English

Русский

Clone this wiki locally