Skip to main content

Install the Astro CLI

You can find information about installing, upgrading, and uninstalling the Astro CLI.

Install the Astro CLI

info

If you want to run your first DAG on Astro but don't want to install any software locally, you can instead deploy DAGs with GitHub Actions. Astronomer recommends this option if your organization restricts the use of Docker or if you have trouble installing the Astro CLI on Windows.

Install the Astro CLI on a Mac operating system 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:

brew install astro@<major.minor.patch-version>

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

    If this is not the first time you're installing the CLI, see Common Issues in the Homebrew documentation. If this is the first time you're installing the CLI, continue with the following steps.

  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
  4. Install the Astronomer CLI. You can choose to specify the major and minor version by adding the astro@<major.minor.patch-version> flag to the brew install command:

    brew install astro@<major.minor.patch-version>

Upgrade the CLI

To upgrade the Astro CLI to the latest version, run the following command:

brew upgrade astro

Uninstall the 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.