Skip to main content

astro deployment variable list

Description

For a given Deployment on Astro, list its running environment variables in your terminal. To test these environment variables locally without having to manually copy them, you can also use this command to save them in a local .env file.

If an existing .env file already exists in your current directory, --save will append environment variables to the bottom of that file. It will not override or replace its contents. If .env does not exist, --save will create the file for you.

If an environment variable value is set as secret, the CLI will list only its key.

Usage

astro deployment variable list
tip

To run this command in an automated process such as a CI/CD pipeline, set the following OS-level environment variables in a way that the Astro CLI can access them:

  • ASTRONOMER_KEY_ID
  • ASTRONOMER_KEY_SECRET

After setting the variables, this command works for a Deployment without you having to manually authenticate to Astronomer. Astronomer recommends storing ASTRONOMER_KEY_SECRET as a secret before using it to programmatically update production-level Deployments.

Options

OptionDescriptionPossible Values
-d,--deployment-idThe Deployment for which to list environment variablesAny valid Deployment ID
-e,--envThe directory where a .env file will be created if it does not exist. If not specified, it will be created in your current directoryAny valid filepath
-k,--keyList only the environment variable associated with this key. If not specified, all environment variables are listedAny string
-s,--saveSave environment variables to a local .env file``
-w,--workspace-idList environment variables for a Deployment that is not in your current Workspace. If not specified, your current Workspace is assumedAny valid Workspace ID

Examples

# Save all environment variables currently running on an Astro Deployment to the `.env` file in your current directory
$ astro deployment variable list --deployment-id cl03oiq7d80402nwn7fsl3dmv --save

# Save only a single environment variable from a Deployment on Astro to a `.env` file that is outside of your current directory
$ astro deployment variable list --deployment-id cl03oiq7d80402nwn7fsl3dmv --key AIRFLOW__CORE__PARALLELISM --save --env /users/documents/my-astro-project/.env