CLI referenceastro dev

astro dev start

The behavior and format of this command are the same for both Astro and Software.

Build your Astro project into a Docker image and spin up a local Docker container for each Airflow component.

This command can be used to build an Astro project and run it locally. For more information, see Build and run a project locally.

Usage

1astro dev start

Options

OptionDescriptionPossible Values
--build-secretsRun docker build --secret to mount a secret value to your Docker image.id=<your-secret-id>, src=<path-to-secret> . See Docker documentation.
--compose-fileThe location of a custom Docker Compose file to use for starting Airflow on Docker.Any valid filepath
--deployment-idSpecifies 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
-e,--envPath to your environment variable file. Default is .envValid filepaths
-i, --image-nameThe name of a pre-built custom Docker image to use with your project. The image must be available on your local machine.A valid name for a pre-built Docker image based on Astro Runtime
-n, --no-browserStarts a local Airflow environment without opening a web browser for the Airflow UINone
--no-cacheDo not use cache when building your Astro project into a Docker imageNone
-s, --settings-fileSettings file from which to import Airflow objects. Default is airflow_settings.yaml.Any valid path to an Airflow settings file
--waitAmount 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-idSpecifies 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

1$ astro dev start --env=/users/username/documents/myfile.env

The following error can sometimes occur when the CLI tries to build your Astro Runtime image using Podman:

$WARN[0010] SHELL is not supported for OCI image format, [/bin/bash -o pipefail -e -u -x -c] will be ignored. Must use `docker` format

You can resolve this issue by exporting the BUILDAH_FORMAT environment variable to Podman:

1export BUILDAH_FORMAT=docker