bdy environment update

$bdy environment update|edit [options] <identifier>

Update an environment Required scopes: ENVIRONMENT_WRITE

ARGUMENTS

identifier

Environment identifier (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

-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

-n, --name <name>

Environment name

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

Rename environment

bdy env edit environment-identifier -n "New name"$

Set tags

bdy env edit environment-identifier --tags prod,stable$

Set icon

bdy env edit environment-identifier --icon 🚀$

Clear note

bdy env edit environment-identifier --note ""$

Return the result as JSON

bdy environment update staging --name Staging --format json$