Skip to main content

Astro CLI Command Reference

Overview

The Astro CLI is the easiest way to run Apache Airflow on your local machine. From the CLI, you can run a local Apache Airflow environment with a dedicated Webserver, Scheduler and Postgres Database. If you're an Astro user, you can also create and manage users, Workspaces, Deployments, and more.

This document contains information about all commands and settings available in the Astro CLI, including examples and flags. To install the Astro CLI, see Install the CLI.

info

All reference documentation is based on the latest available version of the Astro CLI. To see the differences across various CLI versions, see the Astro CLI Release Notes.

Core Commands

We expect that you'll use these commands most often when managing your Astro projects and Deployments:

Each of these commands has a dedicated documentation page with additional notes and examples. As we expand functionality for the Astro CLI, new commands will be listed here.

Global Options

The Astro CLI has one global flag that can be used with any command:

  • -h, --help: Output more information about a given command to the CLI.