bdy variable create

View as Markdown

$bdy variable create|add [options] <key> [value]

Create a variable Required scopes: VARIABLE_WRITE

ARGUMENTS

key

Variable key (name) (required)

value

Variable value. For a secret prefer --file - (stdin), which keeps it out of the shell history (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

--pipeline <identifier>

Pipeline identifier to scope the variable to. Requires --project

--environment <identifier>

Environment identifier to scope the variable to. Resolves a workspace environment; add --project to point at a project environment

--sandbox <identifier>

Sandbox identifier to scope the variable to. Resolves a workspace sandbox; add --project to point at a project sandbox

--scope <scope>

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

--file <path>

Read the value from a file; - reads it from stdin

--encrypted

Encrypt the value. An encrypted value is never shown again: the API returns it masked and pipeline logs hide it

--settable

Allow pipeline actions to change the value

--disable

Disable the variable. A disabled variable is not injected anywhere

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

bdy update delete

Examples

Create a workspace variable

bdy var add API_URL https://api.example.com --scope WORKSPACE$

Create an encrypted project variable, value from stdin create a settable pipeline variable

bdy var add VERSION 1.0.0 --settable -p project --pipeline pipeline-identifier$

Create an environment variable from a file

bdy var add CONFIG --file config.json --environment environment-identifier$

Return the result as JSON

bdy variable create API_URL https://api.example.com --format json$