bdy sandbox create

$bdy sandbox create|add [options]

Create a new sandbox. Pre-installed tools: node 24, docker 29, go 1.25, python 3, git, curl, wget, jq, rsync, ripgrep, unzip, nano, bdy Required scopes: SANDBOX_WRITE

OPTIONS

--context <name>

Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.

--examples

Show only examples; with this flag --format accepts text, json or jsonl

--verbose

Show REST API requests, responses, timing and retries on stderr

-w, --workspace <domain>

Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE

-p, --project <name>

Project name. Can be set via variable: BUDDY_PROJECT

--scope <scope>

Force scope (WORKSPACE, PROJECT, ENVIRONMENT). By default calculated by provided options and environmental variables (--project, --environment, BUDDY_PROJECT, linked project)

-e, --environment <identifier>

Environment identifier

-n, --name <name>

Sandbox display name. Defaults to the first --fetch source (repository, project repo branch, or artifact) when not set

--note <note>

Sandbox note

--agent-note <note>

Sandbox note for AI agents; stored as agent_note and meant to be read before acting on the resource

-i, --identifier <identifier>

Sandbox identifier

--os <image>

Operating system image (ubuntu:24.04 (default), ubuntu:22.04)

--snapshot <snapshot-name>

Create from snapshot name (instead of OS)

--resources <spec>

Resource allocation: 1x2, 2x4, 3x6, 4x8, 5x10, 6x12, 7x14, 8x16, 9x18, 10x20, 11x22, 12x24 (CPUxRAM)

--boot-command <commands...>

Setup commands to run on creation (can be used multiple times)

--boot-script <filepath>

Path to a file with setup commands to run on creation (one per line). Plain commands only — no shebang, the file content is executed as-is

--app-command <commands...>

Application command to run at startup (can be used multiple times)

--app-dir <directory>

Application directory of the sandbox

--tag <tags...>

Tags to add on creation (can be used multiple times)

--timeout <seconds>

The timeout in seconds after which the sandbox will be automatically stopped

--fetch [fetch...]

Fetch sources (can be used multiple times).

-v, --variable <variables...>

Variable key=value or key:value. Can be passed multiple times to pass multiple variables

--vf, --variables-from-file <filepath>

File with variables, key=value. Each variable in new line

--vff, --variable-from-file <variables...>

Variable from file, key=path/to/file or key:path/to/file. Can be passed multiple times to pass multiple variables

--vm, --variable-masked <variables...>

Variable key=value or key:value. Can be passed multiple times to pass multiple variables

--vmf, --variables-masked-from-file <filepath>

File with variables, key=value. Each variable in new line

--vmff, --variable-masked-from-file <variables...>

Variable from file, key=path/to/file or key:path/to/file. Can be passed multiple times to pass multiple variables

--yaml <content|@path>

Complete sandbox YAML. To specify file use @path/to/file format in value

--wait-for-running [seconds]

Wait until sandbox is running

--wait-for-configured [seconds]

Wait until sandbox ran setup commands

--wait-for-apps [seconds]

Wait until sandbox apps are running

--format <text|json>

Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")

-h, --help

display help for command

Documentation for bdy v1.25.34

Last modified on Nov 3, 2026

cp destroy

Examples

Create ubuntu 22.04 sandbox with name and wait for start

bdy sb create -n "name" --os ubuntu:22.04  --wait-for-running$

Create sandbox with identifier, run install commands and wait for start & commands to complete

bdy sb create -i "test" --boot-command "apt-get update && apt-get install nginx -y" --wait-for-configured$

Run commands from the file

bdy sb create --boot-script /path/to/file$

Create sandbox with custom resources and tag it

bdy sb create --resources 4x8 --tag "tag1" --tag "tag2"$

Create sandbox and fetch project repository from default branch to working directory

bdy sb create --fetch$

Create sandbox and fetch project repository branch

bdy sb create --fetch feature-branch$

Create sandbox and fetch public repository

bdy sb create --fetch "path=/home/buddy/repo,url=https://public-repo.com,ref=feature-branch"$

Create sandbox and fetch artifact

bdy sb create --fetch "path=/home/buddy/repo,artifact=name@version"$

Create sandbox named after the fetched repository and branch ("Hello-World master")

bdy sb create --fetch "url=https://github.com/octocat/Hello-World.git,ref=master"$

Create sandbox, fetch project repo branch and build

bdy sb create --fetch "path=/home/buddy/repo,ref=branch,build=npm install && npm run build"$

Create sandbox and pass custom variables

bdy sb create -v key:val -v a:b$

Create sandbox and pass custom variables from file

bdy sb create --vf path/to/env/file$

Create sandbox from yaml file

bdy sb create --yaml @./test.yml"$

Return the result as JSON

bdy sandbox create --format json$

Create http endpoint on port 80 (http server must listen on 0.0.0.0)

bdy sb ep create sandbox-identifier -e 80$

Create http server and serve files from sandbox directory

bdy sb ep create sandbox-identifier -s /path/to/dir$

Create tcp endpoint on port 22 with name (tcp server must listen on 0.0.0.0)

bdy sb ep create sandbox-identifier -t TCP -e 22 -n test$

Return the result as JSON

bdy sandbox endpoint add my-sandbox --name web --type HTTP --endpoint 8080 --format json$