astro env variable update

This command is only available on Astro.

Set the value of an environment variable. By default this command upserts: if the key doesn’t exist, the CLI creates it. Pass --strict to fail when the key is missing. Use --from-file to bulk-upsert variables from a dotenv file. The platform API doesn’t allow toggling the secret flag on an existing variable. To change whether an existing variable is secret, delete it and recreate it.

Usage

astro env variable update [<id-or-key>]

Options

Option	Description	Possible Values
`<id-or-key>`	The ID or key of the variable to update. Omit this argument when you use `--from-file`.	Any valid variable ID or key
`-v`,`--value`	The new variable value. If omitted, the CLI reads the value from stdin when piped, or prompts for it with the input hidden.	Any string
`-s`,`--secret`	When the variable doesn’t exist and the CLI creates it, mark it as secret. This has no effect when updating an existing variable.	None
`--strict`	Fail if the variable doesn’t exist instead of creating it.	None
`--from-file`	Bulk-upsert variables from a dotenv file. Pass `-` to read from stdin. Mutually exclusive with `--value` and the positional `<id-or-key>`.	Any valid file path, or `-`
`--auto-link`	Workspace scope only. Automatically link the variable to all Deployments in the Workspace, including future ones.	None
`--workspace-id`	Set the Workspace scope. Mutually exclusive with `--deployment-id`. Defaults to your current Workspace from CLI context.	Any valid Workspace ID
`--deployment-id`	Set the Deployment scope. Mutually exclusive with `--workspace-id`.	Any valid Deployment ID

Examples

# Update a Workspace variable's value
astro env variable update DBT_PROFILES_DIR --workspace-id <workspace-id> --value /etc/profiles

# Bulk-upsert variables from a dotenv file
astro env variable update --workspace-id <workspace-id> --from-file .env

# Fail if the variable doesn't already exist
astro env variable update DBT_PROFILES_DIR --workspace-id <workspace-id> --value /etc/profiles --strict

Overview

Install the CLI

Develop with the CLI

Configure the CLI

Release information

Archived versions

astro env variable update

Usage

Options

Examples

​Usage

​Options

​Examples

​Related commands

Usage

Options

Examples

Related commands