Skip to main content

Install the Astro CLI

This document explains all of the possible ways to install, upgrade, and uninstall the Astro CLI. Install the Astro CLI to start running Airflow locally or to manage Astro from your terminal.

info

If you can't install the Astro CLI on your local machine, you can still run Astro CLI commands and deploy to Astro using GitHub Actions.

Install the Astro CLI

Install the Astro CLI on Mac OS with a single command.

Prerequisites

By default, the Astro CLI uses Docker as its container management engine for running Airflow locally. However, if your organization uses Podman to run and manage containers, you can configure the Astro CLI to use it instead. See Run the Astro CLI with Podman for prerequisites and configuration steps.

Installation

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

brew install astro

To install a specific version of the Astro CLI, specify the version you want to install at the end of the command. For example, to install Astro CLI version 1.24.1, you would run the following command:

brew install astro@1.24.1

If you specify only a major version, this command installs the latest minor or patch version available for the major version. For a list of all available versions, see the CLI release notes.

Confirmation

To verify that the correct Astro CLI version was installed, run:

astro version

Resolve installation issues

Follow this procedure when Homebrew fails to install the latest Astro CLI version or the error No formulae or casks found for astro@<major.minor.patch-version> appears. To troubleshoot other Homebrew issues, see Common Issues in the Homebrew documentation.

  1. If the install process is not working, run the following command to update Homebrew and all package definitions (formulae):

    brew update
  2. Re-run the installation again:

    brew install astro
  3. If this is the first time you're installing the CLI and updating Homebrew doesn't work, check to see if astronomer/tap is in your Homebrew tap list:

    brew tap astronomer/tap

    If astronomer/tap is in your tap list and you still can't install the Astro CLI, you might be experiencing a different issue. See Common Issues in the Homebrew documentation.

  4. Run the following command to install the Astronomer CLI:

    brew install astro

Upgrade the Astro CLI

The Astro CLI contains no breaking changes between minor versions within the same major version. Therefore, Astronomer recommends always using the latest minor version of the Astro CLI with in your major version.

Run the following command to upgrade the Astro CLI to the latest version:

brew upgrade astro

Uninstall the Astro CLI

To uninstall the Astro CLI on Mac, run:

brew uninstall astro

Was this page helpful?

Sign up for Developer Updates

Get a summary of new Astro features once a month.

You can unsubscribe at any time.
By proceeding you agree to our Privacy Policy, our Website Terms and to receive emails from Astronomer.