Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesTerraformTunnelsYAMLBuddy GitCLIAPIFAQ

bdy pipeline run start

View as Markdown
$bdy pipeline run start <identifier> [options]

Start a pipeline run and follow its progress Required scopes: PIPELINE_RUN

ARGUMENTS
identifier
Human-readable ID of the pipeline (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
-b, --branch <branch>
Repository branch name
-t, --tag <tag>
Repository tag name
--pr, --pull-request <pull request>
Repository pull request id
-r, --revision <revision>
Repository revision
--comment <comment>
Run comment
-f, --refresh
Deploy from scratch
-c, --clear-cache
Clear cache before running the pipeline
--priority <priority>
Run priority. Can be one of "LOW", "NORMAL" or "HIGH". Default is "NORMAL"
-e, --environment <environment>
Environment in which the pipeline execution runs
-a, --artifact <artifact>
Artifact version to run, in format artifact_name:version
-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
--payload <path>
Path to a file or directory which will be uploaded
--schedule <date>
The date when the execution should be run. Should be set in the format: 2016-11-18T12:38:16.000Z or 30s, 10m, 3h10m30s
--action <actions...>
Action ID to be run in this execution. If not sent, it will be run in accordance with the pipeline's definition. Can be passed multiple times to select multiple actions
-n, --no-wait
Do not wait for run to finish
--no-follow
Do not follow changes, only print final state
--exit-code
Use semantic exit codes: 0 success, 1 unsuccessful, 2 command error, 3 not found, 8 pending
--failed-logs
show the last 100 log lines of each FAILED action
--format <text|jsonl>
Output format: jsonl, text. JSONL CLI errors: {type:"error",error:{code,message,hint}}, exit 1 (2 or 3 with --exit-code). Default: text (choices: "text", "jsonl")
-h, --help
display help for command

Documentation for bdy v1.25.34

Last modified on Nov 3, 2026

Previous pageopenNext pageapprove

Examples

Start a run and show failed action logs after completion
bdy pip run start pipeline-identifier --failed-logs$
Return the current execution state using semantic exit codes
bdy pip run start pipeline-identifier --exit-code --no-wait$
Run pipeline with high priority and upload everything from scratch
bdy pip run start pipeline-identifier --priority HIGH -f$
Run pipeline without cache and wait for execution to complete
bdy pip run start pipeline-identifier -c$
Run pipeline and pass custom variables to execution
bdy pip run start pipeline-identifier -v key:val -v a:b$
Run pipeline and pass custom variables from file
bdy pip run start pipeline-identifier --vf path/to/env/file$
Run pipeline in given environment with specific artifact version
bdy pip run start pipeline-identifier --environment staging --artifact my_app:1.2.3$
Deploy an artifact version to an environment, wait for the result and exit 0 only when it succeeded
bdy pip run start pipeline-identifier -e production -a my_app:1.2.3 --exit-code --no-follow --failed-logs$
Run pipeline and output only final jsonl
bdy pip run start pipeline-identifier --no-follow --format jsonl$