Skip to main content

Install the Astro CLI

Overview

The Astro CLI is the easiest way to run Apache Airflow on your machine.

From the CLI, you can run a local Apache Airflow environment with a dedicated Webserver, Scheduler and Postgres Database. Once you create an Astro project, you can easily customize it (e.g. add Python or OS-level packages, plugins etc.) and test it on your local machine.

You can also use the CLI to:

  • Authenticate to Astro.
  • List the Astro Workspace and Deployments you have access to.
  • Deploy a project to Astro.

This guide provides instructions for how to install the Astro CLI.

Prerequisites

To install and use the Astro CLI on Mac, you must have:

To install and use the Astro CLI on Windows or Linux, you must have:

Install the Astro CLI

Install the Astro CLI by running the following command:

brew install astronomer/cloud/astrocloud

Confirm the Install

To confirm the CLI was installed properly, run the following CLI command:

astrocloud version

If the installation was successful, you should see the following output:

% astrocloud version
Astro CLI Version: 1.5.0

Migrate from the ./astro Executable to the Astro CLI

If you currently use the astro executable file to run CLI commands, we strongly recommend that you upgrade to the Astro CLI. To do this:

  1. Delete the ./astro executable file and any related system environment variables or symbolic links from your machine.
  2. In any existing Astro project directories, delete the .astro subdirectory previously generated by the ./astro executable. This subdirectory might be hidden in graphical file browsers. You can show hidden files using ⌘ + Shift + . on Mac or by selecting View > Hidden items in Windows file explorer.
  3. Run astrocloud dev init in your project directories. This command will populate a directory with the appropriate .astrocloud folder without touching or replacing your existing project files.

Next Steps

Now that you've installed the Astro CLI, you're ready to create an Astro project and start developing locally. For instructions, read Create an Astro project.