The Build CLI organises commands into groups based on the resource they manage. This page is a reference for all available commands. For installation and authentication, see Command Line Interface (CLI).
These options can be used with any command:
| Flag | Description |
|---|
-h, --help | Display help for the given command |
-q, --quiet | Do not output any message |
-V, --version | Display the CLI version |
--ansi / --no-ansi | Force (or disable) ANSI output |
-n, --no-interaction | Do not ask any interactive question |
-v, -vv, -vvv, --verbose | Increase verbosity (normal, more verbose, debug) |
To see help for any command, use the --help flag:
Or use the help command:
| Command | Description |
|---|
bld login | Log in to your Build account (browser-based OAuth) |
bld oidc-login | Log in to your Build cluster via OIDC (SSO, cluster access) |
bld whoami (me) | Display the current logged-in user |
bld logs (log) | Display logs for an application |
bld run | Run a one-off command in a temporary dyno |
bld list | List available commands |
bld help | Display help for a command |
bld completion | Dump the shell completion script |
| Command | Description |
|---|
bld apps:create <name> | Create a new application (-t team, -r region) |
bld apps:list (apps) | List the apps you have access to (-t team) |
bld apps:info [app] | Show details for a specific application |
bld apps:stacks (stack) | Show the current stack for an app |
bld apps:stacks:set <stack> | Set the build stack for an app (e.g. heroku-24) |
| Command | Description |
|---|
bld config:list (config) | List all config vars for an app or environment |
bld config:get <KEY...> | Get one or more specific config vars |
bld config:set <KEY=VALUE...> | Set config vars; reads from STDIN when piped |
bld config:unset <KEY...> | Unset one or more config vars |
config:list and config:get support -s for shell format (KEY=value) and -j for JSON. Both config:set and config:unset accept -e ENV-ID to target a pipeline environment instead of -a APP.
| Command | Description |
|---|
bld buildpacks:list (buildpacks) | List the buildpacks configured for an app, in order |
bld buildpacks:add <buildpack> | Append a buildpack (-i to insert at a position) |
bld buildpacks:set <buildpack> | Replace the first buildpack (or -i index) |
bld buildpacks:remove [buildpack] | Remove by name/URL or by -i index |
bld buildpacks:clear | Remove all buildpacks from an app |
| Command | Description |
|---|
bld ps:list (ps, ps:ls) | List running processes and their state/size |
bld ps:scale <TYPE=QTY[:SIZE]...> | Scale process count and/or dyno size |
bld ps:restart [process] | Restart all processes, or a specific process type |
bld ps:exec | Execute a command in a running dyno (-d dyno, -s status) |
| Command | Description |
|---|
bld domains | List all domains (platform + custom) for an app |
bld domains:add <hostname> | Add a custom domain (-w to wait for it to become active) |
bld domains:info <hostname> | Show detailed status for a domain |
bld domains:update <hostname> | Update a domain’s SSL certificate |
bld domains:wait <hostname> | Wait for a domain to finish provisioning |
bld domains:remove <hostname> | Remove a custom domain |
bld domains:clear | Remove all custom domains from an app |
| Command | Description |
|---|
bld namespaces:list (namespaces) | List namespaces you’re a member of or own (-t team) |
bld namespaces:create <name> | Create a namespace (-t team, -r region, -z zone) |
bld namespaces:info [namespace] | Show details for a namespace |
bld namespaces:delete <namespace> | Delete a namespace |
See Namespaces for a full walkthrough.
| Command | Description |
|---|
bld teams:list (teams) | List the teams you’re a member of or own |
bld teams:info [team] | Show details for a team |
| Command | Description |
|---|
bld pipelines:list (pipelines) | List pipelines accessible to you (-t team) |
bld pipelines:info <pipeline> | Show detailed information for a pipeline |
bld pipelines:diff | Compare a source app’s latest release to its downstream app(s) |
bld pipelines:promote | Promote a source app’s latest release downstream (--to, --no-wait) |
| Command | Description |
|---|
bld addons:services | List available add-on services |
bld addons:plans <service> | List plans for an add-on service |
bld addons:create <service:plan> | Provision an add-on for an app |
bld addons:list (addons) | List add-ons provisioned for an app or team |
bld addons:info <addon> | Show details about a provisioned add-on |
bld addons:attach <addon> | Attach an existing add-on to another app |
bld addons:detach <attachment> | Detach an add-on from an app |
bld addons:destroy <addon> | Permanently destroy an add-on |
See build.io/add-ons for the full catalog and usage examples.
