Documentation Index
Fetch the complete documentation index at: https://astronomer-preview.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
The behavior and format of this command are the same for both Astro and Astro Private Cloud.
Usage
Options
| Option | Description | Possible Values |
|---|---|---|
--build-secrets | Run docker build --secret to mount a secret value to your Docker image. Docker mode only. | id=<your-secret-id>, src=<path-to-secret> . See Docker documentation. |
--compose-file | The location of a custom Docker Compose file to use for starting Airflow on Docker. Docker mode only. | Any valid filepath |
--deployment-id | Specifies a Deployment whose Environment Manager configurations you want to use locally. When Airflow builds locally, Astro populates the Airflow metadata database with the Airflow objects specified from the Deployment Environment Manager in the Astro UI. Local development access to connections must be enabled first. See Use Airflow connections hosted on Astro in a local environment. | Any valid Deployment ID |
--docker | Run in Docker mode. Use to override the dev.mode project config for a single command. | None |
-e,--env | Path to your environment variable file. Default is .env | Valid filepaths |
-f, --foreground | Run Airflow in the foreground instead of as a background process. Standalone mode only. | None |
-i, --image-name | The name of a pre-built custom Docker image to use with your project. The image must be available on your local machine. Docker mode only. | A valid name for a pre-built Docker image based on Astro Runtime |
-n, --no-browser | Starts a local Airflow environment without opening a web browser for the Airflow UI. Docker mode only. | None |
--no-cache | Do not use cache when building your Astro project into a Docker image. Docker mode only. | None |
--no-proxy | Disable the built-in reverse proxy and use classic fixed-port behavior. | None |
-p, --port | Port for the Airflow API server. Standalone mode only. | Any valid port number |
-s, --settings-file | Settings file from which to import Airflow objects. Default is airflow_settings.yaml. | Any valid path to an Airflow settings file |
--standalone | Run in standalone mode without Docker. Use to override the dev.mode project config for a single command. See Standalone mode. | None |
--wait | Amount of time to wait for the webserver to get healthy before timing out. The default is 1 minute for most machines and 5 minutes for Apple M1 machines. | Time in minutes defined as <integer>m and time in seconds defined as <integer>s |
-workspace-id | Specifies a Workspace whose Environment Manager configurations you want to use locally. When Airflow builds locally, Astro populates the Airflow metadata database with the Airflow objects to all Deployments in the Workspace. | Any valid Workspace ID |
Examples
The following error can sometimes occur when the CLI tries to build your Astro Runtime image using Podman:You can resolve this issue by exporting the
BUILDAH_FORMAT environment variable to Podman:Standalone mode
Standalone mode runs Airflow directly on your machine in a virtual environment, without Docker. Use it when Docker isn’t available or when you want a lighter-weight local setup. To set standalone as the default mode for a project:astro dev buildastro dev upgrade-testastro dev compose-export
astro dev run --standalone is not supported. To run Airflow CLI commands in standalone mode, set standalone as the default mode first: