bdy environment create

$bdy environment create|add [options] [name]

Create an environment Required scopes: ENVIRONMENT_WRITE

ARGUMENTS

name

Environment name (required)

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

-i, --identifier <identifier>

Human-readable ID of the environment. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)

-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). By default calculated by provided options and environmental variables (--project, BUDDY_PROJECT, linked project)

--tags <tags>

Comma-separated list of tags

--public-url <url>

Public URL of the environment

--icon <icon>

Icon of the environment (an emoji, e.g. 🚀)

--note <note>

Resource note

--agent-note <note>

Note for AI agents operating on this resource; stored as agent_note and meant to be read before acting on the resource

--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

Examples

Create workspace environment

bdy env create staging$

Create project environment

bdy env create staging -p project$

Create environment with identifier and tags

bdy env create "Staging" -i staging --tags staging,test$

Create environment with a public url

bdy env create staging --public-url https://staging.example.com$

Return the result as JSON

bdy environment create staging --format json$