CLI referenceastro dev

astro dev init

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

Initialize an Astro project in an empty local directory. An Astro project contains the set of files necessary to run Airflow, including dedicated folders for your dag files, plugins, and dependencies. An Astro project can be either run locally with astro dev start or pushed to Astronomer with astro deploy.

Usage

1astro dev init <project-name>

Options

OptionDescriptionPossible Values
<project-name>Optional name for your Astro project. Automatically creates and initializes a directory with the specified name.Any supported Airflow version
-a, --airflow-versionVersion of Airflow you want to create an Astro project with. If not specified, latest is assumed. You can change this version in your Dockerfile at any time.String
-v, --runtime-versionInitialize a project with a specific Runtime versionAny supported Runtime version
-n,--nameName of your Astro projectAny string
--from-templateSpecify a getting started template to use as the base for your Astro project.etl, dbt-on-astro, generative-ai, or learning-airflow
--use-astronomer-certifiedOnly for use on Astronomer Software. Initializes your project with an Astronomer Certified image.None

Examples

1$ astro dev init
2# Initializes default project
3
4$ astro dev init --name=MyProject
5# Generates `config.yaml` file with `name=MyProject`
6
7$ astro dev init --runtime-version=4.0.7
8## Initializes project with Runtime 4.0.7