CLI referenceastro envastro env variable

astro env variable create

This command is only available on Astro.

Create a single environment variable with --key and --value, or bulk-create variables from a dotenv file with --from-file. When you use --from-file, the --secret and --auto-link flags apply to every entry in the file.

Usage

$astro env variable create

Options

OptionDescriptionPossible Values
-k,--keyThe variable key. Required unless you use --from-file.Any string
-v,--valueThe variable value. If omitted, the CLI reads the value from stdin when piped, or prompts for it with the input hidden.Any string
-s,--secretMark the variable as secret.None
--from-fileBulk-create variables from a dotenv file with one KEY=VALUE per line. Pass - to read from stdin. Mutually exclusive with --key and --value.Any valid file path, or -
--auto-linkWorkspace scope only. Automatically link the variable to all Deployments in the Workspace, including future ones.None
--workspace-idSet the Workspace scope. Mutually exclusive with --deployment-id. Defaults to your current Workspace from CLI context.Any valid Workspace ID
--deployment-idSet the Deployment scope. Mutually exclusive with --workspace-id.Any valid Deployment ID

Examples

$# Create a Workspace variable
$astro env variable create --workspace-id <workspace-id> --key DBT_PROFILES_DIR --value /opt/profiles
$
$# Create a secret Workspace variable and auto-link it to every Deployment
$astro env variable create --workspace-id <workspace-id> --key API_TOKEN --value $TOKEN --secret --auto-link
$
$# Bulk-create variables from a dotenv file
$astro env variable create --workspace-id <workspace-id> --from-file .env