Install the Astro CLI

Overview

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

The Astro CLI is the easiest way to run Apache Airflow on your machine. From the Astro CLI, you can run a local Apache Airflow environment with a dedicated webserver, scheduler and Postgres database. Once you create an Astronomer Software project, you can customize it (for example, add Python or OS-level packages or add plugins) and test it on your local machine.

You can also use the CLI to:

• Authenticate to Astronomer Software.
• List the Astro Workspace and Deployments you can access.
• Deploy a project to Software.

Install the Astro CLI

Mac

Prerequisites

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

• Homebrew
• Docker Desktop (v18.09 or higher).

Installation

To install the latest version of the Astro CLI, run the following command:

brew install astro

Windows

Prerequisites

To use the Astro CLI on Windows, you must have:

• Docker Desktop for Windows.
• Docker Engine (v0.13.1 or higher).
• WSL enabled on your local machine.
• Windows 10 or Windows 11.

Installation

1. Go to the Releases page of the Astro CLI GitHub repository. Based on your desired CLI version and the CPU architecture of your machine, download one of the .zip files available on this page.

   For example, to install v1.0.0 of the Astro CLI on a Windows machine with an AMD 64 architecture, download astro_1.0.0-converged_windows_amd64.zip.

2. If the .zip file does not automatically unzip, run the following command to unzip the executable:

   tar -xvzf .\astrocli.tar.gz

3. Add the filepath for the directory containing astro.exe as a PATH environment variable. For example, if astro.exe was stored in C:\Users\username\astro.exe, you would add C:\Users\username as your PATH environment variable. To learn more about configuring the PATH environment variable, see Java documentation.

4. Restart your machine.

Linux

Prerequisites

To use the Astro CLI on Linux, you must have:

• Docker Engine (v0.18.9 or higher).

Installation

Run the following command to install the latest version of the Astro CLI directly to PATH:

curl -sSL install.astronomer.io | sudo bash -s

Confirm the install

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

astro version

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

% astro version
Astro CLI Version: 1.2.0