CLI referenceastro deploymentastro deployment variable

astro deployment variable list

This command is only available on Astro.

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

1astro deployment variable list

This command is recommended for automated workflows. To run this command in an automated process such as a CI/CD pipeline, you can generate an API token, then specify the ASTRO_API_TOKEN environment variable in the system running the Astro CLI:

$export ASTRO_API_TOKEN=<your-token>

See Organization, Workspace, and Deployment API token documentation for more details about ways to use API tokens.

Options

OptionDescriptionPossible Values
-d,--deployment-idThe ID of the Deployment for which to list environment variablesAny valid Deployment ID
--deployment-nameThe name of the Deployment for which to list environment variable(s). Use as an alternative to <deployment-id>.Any valid Deployment name
-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

1# Save all environment variables currently running on an Astro Deployment to the `.env` file in your current directory
2$ astro deployment variable list --deployment-id cl03oiq7d80402nwn7fsl3dmv --save
3
4# Save only a single environment variable from a Deployment on Astro to a `.env` file that is outside of your current directory
5$ astro deployment variable list --deployment-name="My Deployment" --key AIRFLOW__CORE__PARALLELISM --save --env /users/documents/my-astro-project/.env