Skip to content

sandboxes_cli.rst

Latest commit

 

History

History
48 lines (34 loc) · 1.35 KB

sandboxes_cli.rst

File metadata and controls

48 lines (34 loc) · 1.35 KB
Raw

Sandboxes CLI examples

Sandbox CLI commands use a sandbox API key. For teamspace-scoped operations, create a teamspace API key in Lightning AI and pass it through the environment or --api-key. Do not commit API keys to source control.

Create a sandbox

$ pip install lightning-sdk -U
$ export LIGHTNING_SANDBOX_API_KEY="replace-at-runtime"

$ lightning sandbox create \
    --name sdk-tutorial-sandbox \
    --teamspace owner/teamspace \
    --instance-type cpu-1 \
    --persistent \
    --json

Run commands

$ export SANDBOX_ID=sbx_1234567890
$ lightning sandbox run "$SANDBOX_ID" -- python -c "print('hello from sandbox')"
$ lightning sandbox run "$SANDBOX_ID" --cwd /workspace --env MODE=tutorial -- python app.py

Run detached and inspect logs

$ lightning sandbox run "$SANDBOX_ID" --detached -- bash -lc "echo start; sleep 5; echo done"
$ lightning sandbox command "$SANDBOX_ID" cmd-abc123
$ lightning sandbox logs "$SANDBOX_ID" cmd-abc123 --no-timestamps

Stop, resume, and delete

$ lightning sandbox stop "$SANDBOX_ID" --json
$ lightning sandbox start "$SANDBOX_ID"
$ lightning sandbox delete "$SANDBOX_ID"