Skip to main content

environments

Aliases: environment, env, envs

Manage Altostra environments

Sub-Commands

get

Aliases: list

List all available environments for your Altostra account.

List all environments

alto environments list

Display details for a single environment

alto environments get <environment-name>
Arguments
environment-name

The name of the environment for which to print the details.

Required: no

create

Create a new environment.

alto environments create new-environment
Arguments
environment-name

The environment name.

Required: yes
--region

The region that the environment represents.

Required: no
--account

The account that the environment represents.

Required: no
--expiration-minutes

The expiration time in minutes after which stacks in the environment are automatically deleted.

Required: no

update

Aliases: set

Update an environment.

Update environment

alto environments update <environment-name> \
--name new-name \
--description "Env description" \
--expiration-minutes 60

Clear environment description

alto environments update <environment-name> --no-description

Clear environment expiration

alto environments update <environment-name> --no-expiration-minutes
Arguments
environment-name

The environment name.

Required: yes
Options
--name

Set a new name for the environment.

Required: no
--description

Set a description for the environment.

Required: no
Aliases: --desc
--no-description

Clear the environment description.

Required: no
Aliases: --no-desc
--expiration-minutes

The expiration time in minutes for stacks deployed to the environment.

Required: no
Aliases: --expiration, --exp
--no-expiration-minutes

Clear the expiration time for stacks in the environment.

Required: no
Aliases: --no-expiration, --no-exp

update-params

Aliases: set-params

Update environment parameters.

Update single environment parameter

alto environments update-params <environment-name> \
--key param-name \
--value "Parameter value"

Update environment parameters from file

alto environments update-params <environment-name> --file parameters.json

Update environment parameters from STDIN

alto environments update-params <environment-name> --file -
Arguments
environment-name

The environment name.

Required: yes
Options
--key

The parameter key.

Required: no
--value

The parameter value.

Required: no
--file

The name of a JSON file to read parameters from. Use - to read from STDIN.

Required: no

parameters

Aliases: params

Get environment parameters.

alto environments parameters <environment-name>
Arguments
environment-name

The environment name.

Required: no

projects

List projects deployed to an environment.

alto environments projects <environment-name>
Arguments
environment-name

The environment name.

Required: no

delete

Delete the environment.

alto environments delete <environment-name>
Arguments
environment-name

The environment name.

Required: no

Ready to Get Started?

Get Started for Free
© 2022 Altostra, Inc.