environments Command

The environments command allows you to manage environments defined in the .bruin.yml configuration file. It supports listing all available environments in the current Git repository and creating new ones.

Usage

bruin environments [subcommand]

list Subcommand

Displays the environments defined in the .bruin.yml configuration file in the current Git repository. The environments can be displayed in plain text or JSON format.

Flags

Flag	Type	Default	Description
--output, -o	str	plain	Output format: plain or json.
--config-file	str	-	The path to the .bruin.yml file.

Usage

bruin environments list [flags]

create Subcommand

Creates a new environment entry in the .bruin.yml configuration file.

Flags

Flag	Type	Default	Description
--name, -n	str	-	Name of the environment to create.
--schema-prefix, -s	str	-	Optional schema prefix to use for the environment.
--output, -o	str	plain	Output format: plain or json.
--config-file	str	-	The path to the .bruin.yml file.

Usage

bruin environments create --name dev [--schema-prefix my_prefix]

clone Subcommand

Creates a copy of an existing environment with a new name. All connections from the source environment are copied to the target environment. Optionally allows setting or overriding the schema prefix for the cloned environment.

Flags

Flag	Type	Default	Description
--source, -s	str	Default environment	Name of the environment to clone from.
--target, -t	str	-	Required. Name of the new environment.
--schema-prefix, -p	str	-	Optional schema prefix for the cloned environment. If not provided, uses the source environment's schema prefix.
--output, -o	str	plain	Output format: plain or json.
--config-file	str	-	The path to the .bruin.yml file.

Usage

# Clone the default environment to a new environment
bruin environments clone --target staging

# Clone a specific environment to a new environment
bruin environments clone --source production --target staging

# Clone with a custom schema prefix
bruin environments clone --target dev --schema-prefix dev_

# Clone with JSON output
bruin environments clone --target test --output json

Examples

Clone the default environment:

bruin environments clone --target staging

Clone a specific environment with a schema prefix:

bruin environments clone --source production --target dev --schema-prefix dev_

update Subcommand

Updates an existing environment in the .bruin.yml configuration file. You can rename the environment or change its schema prefix.

Flags

Flag	Type	Default	Description
--name, -n	str	-	Name of the environment to update.
--new-name	str	-	New name for the environment.
--schema-prefix, -s	str	-	New schema prefix for the environment.
--output, -o	str	plain	Output format: plain or json.
--config-file	str	-	The path to the .bruin.yml file.

Usage

bruin environments update --name dev --schema-prefix new_prefix_
bruin environments update --name dev --new-name development

delete Subcommand

Deletes an environment from the .bruin.yml configuration file.

Flags

Flag	Type	Default	Description
--name, -n	str	-	Name of the environment to delete.
--force, -f	bool	false	Skip confirmation prompt.
--output, -o	str	plain	Output format: plain or json.
--config-file	str	-	The path to the .bruin.yml file.

Usage

bruin environments delete --name dev
bruin environments delete --name staging --force