Reference

Blossom CLI Reference

Reference for Blossom CLI commands

Reference

Exact contracts for the Blossom CLI

blossom account

Manage Accounts

blossom account:create

Create an Account

blossom account:delete

Delete an empty Account

blossom account:init

Create a starter account.yml

blossom account:list

Show your Accounts

blossom account:member

account member commands

blossom account:member:init

Create a starter member.yml

blossom account:member:list

List Account members

blossom account:member:remove

Remove an Account member

blossom account:member:show

Show an Account member

blossom account:member:update

Update an Account member

blossom account:show

Show selected Account details

blossom account:update

Update selected Account settings

blossom activity

View activity history

blossom activity:list

List activity

blossom activity:logs

Show activity logs

blossom activity:show

Show an activity

blossom activity:wait

Wait for an activity to finish and exit by its outcome

blossom app

Manage apps

blossom app:create

Create an app

blossom app:delete

Delete an app

blossom app:init

Create a starter app.yml

blossom app:list

List apps

blossom app:show

Show an app

blossom app:update

Update an app

blossom app_plan

Manage App Plans

blossom app_plan:create

Save an App Plan and show its resources and capacity

blossom app_plan:delete

Discard an App Plan; what it deployed stays

blossom app_plan:deploy

Deploy a plan into a new Environment and start its first deployment

blossom app_plan:init

Write app_plan.yml from the repository in the working directory, or from a saved App Plan

blossom app_plan:list

List App Plans

blossom app_plan:preview

Preview resources and capacity without saving a plan

blossom app_plan:show

Show an App Plan and the Environments it deployed

blossom backup

Manage backups

blossom backup:create

Start a backup

blossom backup:delete

Delete a backup

blossom backup:download

Download a verified PostgreSQL logical export

blossom backup:init

Create a starter backup.yml

blossom backup:list

List backups

blossom backup:restore

Restore a managed data recovery backup

blossom backup:setting

backup setting commands

blossom backup:setting:show

Show backup settings

blossom backup:setting:update

Configure daily database exports

blossom backup:show

Show a backup

blossom backup_storage

Manage backup storage

blossom backup_storage:create

Create backup storage

blossom backup_storage:delete

Delete backup storage

blossom backup_storage:init

Create a starter backup_storage.yml

blossom backup_storage:list

List backup storage

blossom backup_storage:show

Show backup storage

blossom backup_storage:update

Update backup storage

blossom billing

View billing

blossom billing:invoice

View billing invoices

blossom billing:invoice:list

List billing invoices

blossom billing:invoice:show

Show billing invoice

blossom billing:profile

Show billing profile

blossom billing:usage

Show billing usage

blossom billing:usage:export

Export billing usage CSV

blossom builder

Build separately from running Apps

blossom builder:create

Create and prepare a Builder

blossom builder:delete

Delete a Builder after accepted Builds finish

blossom builder:init

Create a starter builder.yml

blossom builder:list

List Builders

blossom builder:show

Show a Builder

blossom builder:update

Update Builder settings

blossom cache_instance

Manage Blossom Managed Cache instances

blossom cache_instance:activity

List cache instance activity

blossom cache_instance:console

Open a cache instance console

blossom cache_instance:create

Create a Dedicated or Shared Cache instance

blossom cache_instance:credentials

Show a cache_instance's connection credentials

blossom cache_instance:credentials:rotate

Rotate the Cache instance password

blossom cache_instance:delete

Delete a cache instance

blossom cache_instance:init

Create a starter cache instance.yml

blossom cache_instance:list

List cache instances

blossom cache_instance:replica

Manage Redis read replicas

blossom cache_instance:replica:create

Add a Redis replica

blossom cache_instance:replica:delete

Delete a Redis replica

blossom cache_instance:replica:list

List Redis replicas

blossom cache_instance:replica:show

Show a Redis replica

blossom cache_instance:show

Show a cache instance

blossom cache_instance:standby

Show the Redis standby

blossom cache_instance:standby:list

List Redis standbys

blossom cache_instance:standby:show

Show a Redis standby

blossom cache_instance:switchover

Switch Redis to its standby

blossom cache_instance:update

Update a cache instance

blossom capacity

View capacity allocations and configure App Capacity

blossom capacity:activity

List capacity allocation activity

blossom capacity:init

Create a starter capacity.yml

blossom capacity:limit_request

capacity limit_request commands

blossom capacity:limit_request:create

Ask for more Locations or a higher Location capacity ceiling

blossom capacity:limit_request:list

List capacity limit requests and the limit that stands today

blossom capacity:list

List capacity allocations

blossom capacity:retire

Retire all active App Capacity now

blossom capacity:server

capacity server commands

blossom capacity:server:list

List backing Servers and their lifecycle states

blossom capacity:show

Show capacity allocations

blossom capacity:update

Update App Capacity policy

blossom cloud_provider

Manage cloud providers

blossom cloud_provider:check

Check cloud provider credentials

blossom cloud_provider:create

Create a cloud provider

blossom cloud_provider:delete

Delete a cloud provider

blossom cloud_provider:init

Create a starter cloud_provider.yml

blossom cloud_provider:list

List cloud providers

blossom cloud_provider:regions

List cloud provider regions

blossom cloud_provider:server_sizes

List cloud provider server sizes

blossom cloud_provider:show

Show a cloud provider

blossom cloud_provider:types

Show supported cloud provider types

blossom cloud_provider:update

Update a cloud provider

blossom cloud_storage_provider

Manage cloud storage providers

blossom cloud_storage_provider:create

Create a cloud storage provider

blossom cloud_storage_provider:delete

Delete a cloud storage provider

blossom cloud_storage_provider:init

Create a starter cloud_storage_provider.yml

blossom cloud_storage_provider:list

List cloud storage providers

blossom cloud_storage_provider:show

Show a cloud storage provider

blossom cloud_storage_provider:types

Show supported cloud storage provider types

blossom cloud_storage_provider:update

Update a cloud storage provider

blossom completion

Configure shell completion

blossom completion:install

Install shell completion

blossom completion:script

Print a shell completion script

blossom container

View App instances

blossom container:list

List containers

blossom container:show

Show a container

blossom container_registry

Manage container registries

blossom container_registry:create

Create a container registry

blossom container_registry:delete

Delete a container registry

blossom container_registry:init

Create a starter container_registry.yml

blossom container_registry:list

List container registries

blossom container_registry:show

Show a container registry

blossom container_registry:types

Show supported container registry types

blossom container_registry:update

Update a container registry

blossom database

Manage databases within an instance

blossom database:create

Create an isolated namespace in a PostgreSQL engine

blossom database:credentials

Show scoped connection credentials

blossom database:delete

Delete one namespace and its credentials

blossom database:import

Import an upload or Backup into a new Database

blossom database:list

List PostgreSQL databases

blossom database:maintenance

database maintenance commands

blossom database:maintenance:disable

Restore connections to one PostgreSQL database

blossom database:maintenance:enable

Block connections to one PostgreSQL database

blossom database:maintenance:show

Show database maintenance status

blossom database:retry

Retry failed namespace creation

blossom database:show

Show a database

blossom database:upload

Upload or resume a PostgreSQL custom archive

blossom database:upload:delete

Delete a temporary upload or abandon its parts

blossom database:upload:extend

Keep a completed upload for seven more days

blossom database:upload:list

List temporary database uploads

blossom database:upload:show

Show upload state and completed parts

blossom database_instance

Manage Blossom Managed Database instances

blossom database_instance:activity

List database instance activity

blossom database_instance:console

Open a database instance console

blossom database_instance:create

Create a Dedicated or Shared Database instance with its storage

blossom database_instance:credentials

Show a database_instance's connection credentials

blossom database_instance:credentials:rotate

Rotate the Database instance password

blossom database_instance:delete

Delete a database instance

blossom database_instance:init

Create a starter database instance.yml

blossom database_instance:list

List database instances

blossom database_instance:replica

Manage PostgreSQL read replicas

blossom database_instance:replica:create

Add a PostgreSQL replica

blossom database_instance:replica:delete

Delete a PostgreSQL replica

blossom database_instance:replica:list

List PostgreSQL replicas

blossom database_instance:replica:show

Show a PostgreSQL replica

blossom database_instance:retry

Retry a Database instance the provider refused, keeping its storage and endpoint

blossom database_instance:show

Show a database instance

blossom database_instance:standby

Show the PostgreSQL standby

blossom database_instance:standby:list

List PostgreSQL standbys

blossom database_instance:standby:show

Show a PostgreSQL standby

blossom database_instance:switchover

Switch PostgreSQL to its standby

blossom database_instance:update

Update a database instance

blossom database_instance:upgrade

Install the available PostgreSQL minor release

blossom dns_provider

Manage DNS providers

blossom dns_provider:create

Create a DNS provider

blossom dns_provider:delete

Delete a DNS provider

blossom dns_provider:init

Create a starter dns_provider.yml

blossom dns_provider:list

List DNS providers

blossom dns_provider:show

Show a DNS provider

blossom dns_provider:types

Show supported DNS provider types

blossom dns_provider:update

Update a DNS provider

blossom domain

Manage domains

blossom domain:create

Create a domain

blossom domain:delete

Delete a domain

blossom domain:init

Create a starter domain.yml

blossom domain:list

List domains

blossom domain:show

Show a domain

blossom domain:update

Update a domain

blossom env_var

Manage environment variables

blossom env_var:create

Create an environment variable

blossom env_var:delete

Delete an environment variable

blossom env_var:init

Create a starter env_var.yml

blossom env_var:list

List environment variables

blossom env_var:pull

Write an Environment's variables to a .env file

blossom env_var:push

Push a .env file to an Environment

blossom env_var:show

Show an environment variable

blossom env_var:update

Update an environment variable

blossom environment

Manage environments

blossom environment:access

Shareable links and bypass tokens for Environment Access

blossom environment:access:link

Shareable links for people without a Blossom login

blossom environment:access:link:create

Create a shareable link

blossom environment:access:link:list

List an environment's shareable links

blossom environment:access:link:revoke

Revoke a shareable link

blossom environment:access:link:show

Show a shareable link and a fresh URL to copy

blossom environment:access:link:update

Rename a shareable link

blossom environment:access:token

Bypass tokens for automated tests and monitors

blossom environment:access:token:create

Create a bypass token

blossom environment:access:token:list

List an environment's bypass tokens

blossom environment:access:token:revoke

Revoke a bypass token

blossom environment:access:token:show

Show a bypass token

blossom environment:access:token:update

Rename a bypass token

blossom environment:activity

List environment activity

blossom environment:build_config

Manage environment build settings

blossom environment:build_config:init

Create a starter build_config.yml for environment settings

blossom environment:build_config:show

Show environment build settings

blossom environment:build_config:update

Update environment build settings

blossom environment:create

Create an environment

blossom environment:delete

Delete an environment

blossom environment:deploy

Deploy an environment

blossom environment:deploy_hooks

Manage environment deploy hooks

blossom environment:deploy_hooks:init

Create a starter deploy_hooks.yml for environment settings

blossom environment:deploy_hooks:show

Show environment deploy hooks

blossom environment:deploy_hooks:update

Update environment deploy hooks

blossom environment:init

Create a starter environment.yml

blossom environment:list

List environments

blossom environment:load_balancer

Manage environment load balancer settings

blossom environment:load_balancer:init

Create a starter load_balancer.yml for environment settings

blossom environment:load_balancer:show

Show environment load balancer settings

blossom environment:load_balancer:update

Update environment load balancer settings

blossom environment:maintenance

Manage the routing maintenance page

blossom environment:maintenance:disable

Disable the Environment maintenance page

blossom environment:maintenance:enable

Enable the Environment maintenance page

blossom environment:maintenance:show

Show routing maintenance status

blossom environment:pending_changes

Show saved environment settings waiting for deployment

blossom environment:pending_changes:show

Show saved environment settings waiting for deployment

blossom environment:preview

Create and list Previews of an environment

blossom environment:preview:create

Create a Preview of an environment from a branch

blossom environment:preview:data

environment preview data commands

blossom environment:preview:data:delete

Remove the data new Previews start from

blossom environment:preview:data:show

Show the data new Previews start from

blossom environment:preview:data:upload

Upload the data each new Preview's database starts from

blossom environment:preview:delete_all

Delete every Preview of an environment

blossom environment:preview:list

List an environment's Previews

blossom environment:preview:settings

Show how an environment's Previews run

blossom environment:preview:settings:init

Create a starter preview_settings.yml

blossom environment:preview:settings:update

Change how an environment's Previews run

blossom environment:scale

Scale an Environment Service

blossom environment:show

Show an environment

blossom environment:update

Update an environment

blossom environment_link

Manage environment data links

blossom environment_link:create

Create an environment link

blossom environment_link:delete

Delete an environment link

blossom environment_link:init

Create a starter environment_link.yml

blossom environment_link:list

List environment links

blossom environment_link:show

Show an environment link

blossom environment_link:update

Update an environment link

blossom git_provider

Manage Git providers

blossom git_provider:check

Check Git provider connection

blossom git_provider:delete

Delete a Git provider

blossom git_provider:list

List Git providers

blossom git_provider:show

Show a Git provider

blossom git_provider:types

Show supported Git provider types

blossom git_provider:update

Update a Git provider

blossom git_repo

Manage git repositories

blossom git_repo:create

Create a git repository

blossom git_repo:delete

Delete a git repository

blossom git_repo:init

Create a starter git_repo.yml

blossom git_repo:list

List git repositories

blossom git_repo:show

Show a git repository

blossom git_repo:update

Update a git repository

blossom git_ssh_key

Manage Git SSH keys

blossom git_ssh_key:create

Create a Git SSH key

blossom git_ssh_key:delete

Delete a Git SSH key

blossom git_ssh_key:init

Create a starter git_ssh_key.yml

blossom git_ssh_key:list

List Git SSH keys

blossom git_ssh_key:show

Show a Git SSH key

blossom git_ssh_key:update

Update a Git SSH key

blossom help

Show focused help topics

blossom help:all

Show the full command reference

blossom help:data

Explain structured data input

blossom help:env_vars

Explain CLI environment variables

blossom job

Manage saved Jobs and view Job Runs

blossom job:create

Create a Job definition without running it

blossom job:delete

Delete a Job definition and retain Run history

blossom job:init

Create a starter job.yml

blossom job:list

List saved Jobs

blossom job:run

job run commands

blossom job:run:cancel

Request cancellation of a standalone Job Run

blossom job:run:create

Run a saved Job or an ad hoc Environment command

blossom job:run:list

List Job Runs

blossom job:run:logs

Show Job Run logs

blossom job:run:show

Show a Job Run

blossom job:show

Show a saved Job

blossom job:update

Update a Job definition without changing previous Runs

blossom load_balancer

Route public traffic on App Capacity or Dedicated instances

blossom load_balancer:init

Create a starter load_balancer.yml

blossom load_balancer:list

List each region's Load Balancer

blossom load_balancer:show

Show a Load Balancer

blossom load_balancer:update

Choose a Load Balancer outcome

blossom location

Manage Account deployment locations

blossom location:add

Save a Location without provisioning resources

blossom location:list

List saved Locations

blossom location:remove

Remove an empty non-default Location

blossom location:server_sizes

List the Server sizes Blossom may use in a BYOC Location

blossom location:show

Show a Location

blossom location:update

Set a Location's maximum capacity and BYOC Server sizes

blossom location:use

Use a Location for this profile's commands

blossom login

Login with Blossom

blossom logout

Log out of Blossom

blossom logs

Show logs

blossom metric

Show metrics

blossom metric:source

Show available metric sources

blossom metric:source:list

List metric sources

blossom metric:stream

Manage metric streams

blossom metric:stream:create

Create a metric stream

blossom metric:stream:graph

Show a live metric stream graph

blossom metric:stream:init

Create a starter metric_stream.yml

blossom metric:stream:list

List metric streams

blossom metric:stream:show

Show a metric stream

blossom metric:stream:top

Show a live metric stream table

blossom metric:stream:web

Show the Web UI graph for a metric stream

blossom organization

Manage the current organization

blossom organization:close

Close an organization and keep billing history

blossom organization:create

Create an organization

blossom organization:delete

Delete an unused organization

blossom organization:init

Create a starter organization.yml

blossom organization:invitation

organization invitation commands

blossom organization:invitation:create

Invite a member

blossom organization:invitation:delete

Delete an organization invitation

blossom organization:invitation:init

Create a starter invitation.yml

blossom organization:invitation:list

List organization invitations

blossom organization:invitation:resend

Resend an organization invitation

blossom organization:invitation:show

Show an organization invitation

blossom organization:invitation:update

Update an organization invitation

blossom organization:list

Show your organizations

blossom organization:member

organization member commands

blossom organization:member:init

Create a starter member.yml

blossom organization:member:list

List organization members

blossom organization:member:remove

Remove an organization member

blossom organization:member:show

Show an organization member

blossom organization:member:update

Update an organization member

blossom organization:show

Show current organization

blossom organization:update

Update current organization

blossom permission_set

Manage permission sets

blossom permission_set:create

Create a permission set

blossom permission_set:delete

Delete an unused permission set

blossom permission_set:init

Create a starter permission_set.yml

blossom permission_set:list

List permission sets

blossom permission_set:scopes

List available permission scopes

blossom permission_set:show

Show a permission set

blossom permission_set:update

Update a permission set

blossom profile

Manage local CLI profiles

blossom profile:create

Create a profile for one Account

blossom profile:current

Show the current CLI context

blossom profile:delete

Delete a local profile

blossom profile:init

Create a starter profile.yml

blossom profile:list

List local profiles

blossom profile:rename

Rename a local profile and its saved login

blossom profile:use

Switch local profile

blossom quickstart

Browse the Quickstart catalog of ready-to-deploy example Apps

blossom quickstart:list

List Quickstarts

blossom registry_link

Manage registry links

blossom registry_link:create

Create a registry link

blossom registry_link:delete

Delete a registry link

blossom registry_link:init

Create a starter registry_link.yml

blossom registry_link:list

List registry links

blossom registry_link:show

Show a registry link

blossom registry_link:update

Update a registry link

blossom release

View, cancel, and roll back Releases

blossom release:cancel

Cancel a deployment during Release Phase

blossom release:list

List Releases

blossom release:rollback

Roll back to a succeeded Release

blossom release:show

Show a Release

blossom runtime_issue

View durable App runtime issues

blossom runtime_issue:list

List runtime issues

blossom runtime_issue:show

Show a runtime issue

blossom service

Manage application services

blossom service:create

Create a service

blossom service:delete

Delete a service or retire its persistent compute

blossom service:init

Create a starter service.yml

blossom service:list

List services

blossom service:regenerate_url

Replace a service generated URL

blossom service:restart

Restart service containers

blossom service:scale

Scale a service

blossom service:show

Show a service

blossom service:update

Update a service

blossom shell

Open Blossom Shell

blossom skill

Install AI agent skills

blossom skill:install

Install the Blossom CLI AI skill

blossom spending

View Account spending and set the email alert

blossom spending:init

Create a starter spending.yml

blossom spending:show

Show spending, the capacity limit and the email alert

blossom spending:update

Set the Account's email alert

blossom user

Manage your user profile

blossom user:confirm

Confirm a new user

blossom user:delete

Delete your user profile

blossom user:init

Create a starter user payload file

blossom user:register

Register a Blossom user

blossom user:show

Show a user profile

blossom user:update

Update your user profile

blossom version

Show Blossom CLI version

blossom whoami

Show who is logged in