WEBINARLive webinar: Terraform in Buddy, Oct 21st.Terraform: plan, approve, apply with state in Buddy. Live on October 21st.Save your seat

bdy distro update

View as Markdown
$bdy distro update|edit [options] <identifier>

Update a distribution Required scopes: DISTRIBUTION_WRITE

ARGUMENTS
identifier
Human-readable ID of the distribution (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
--scope <scope>
Force scope (WORKSPACE, PROJECT). By default calculated by provided options and environmental variables (--project, BUDDY_PROJECT, linked project)
-p, --project <name>
Project name. Can be set via variable: BUDDY_PROJECT
-n, --name <name>
Name of the distribution
--note <note>
Note of the distribution
--agent-note <note>
Note of the distribution for AI agents; stored as agent_note and meant to be read before acting on the resource
--enable
Enable the distribution
--disable
Disable the distribution
--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.20

Last modified on Oct 14, 2026

Examples

Rename distribution
bdy distro update distro-identifier -n "new name"$
Set note (pass an empty value to clear it)
bdy distro update distro-identifier --note "owned by team web"$
Set the note read by AI agents
bdy distro update distro-identifier --agent-note "deploy: manual-approval-required"$
Disable distribution
bdy distro update distro-identifier --disable$
Return the result as JSON
bdy distro update my-distro --name "New name" --format json$