Skip to main content

Documentation Index

Fetch the complete documentation index at: https://astronomer-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The data orchestration tool for modern teams

Astronomer gives teams everything they need to build, deploy, and operate Apache Airflow with managed infrastructure, developer tooling, enterprise controls, and flexible deployment options.

Quick Start

Start from the right product, create a project, authenticate, and make your first deployment or API request.

1

Choose your entry point

Start with Astro for managed Airflow, Astro Private Cloud for self-hosted deployments, or Learn if you want Airflow tutorials and concepts first.
2

Install the Astro CLI

The CLI is the fastest way to create and run an Astro project locally.
brew install astro
astro dev init
Continue with the CLI quickstart for a full local development workflow.
3

Authenticate and deploy

Create an Astro account, sign in, and push code to a Deployment.
astro login
astro deploy
For the full managed workflow, see Start your Astro trial and Deploy code to Astro.
4

Explore the API

Use the Astro API when you need automation, provisioning, or integration with your own tooling.
curl --location 'https://api.astronomer.io/v1/organizations/<your-organization-id>/clusters' \
--header 'Authorization: Bearer <your-api-token>'
{
  "clusters": [],
  "limit": 10,
  "offset": 0,
  "totalCount": 0
}
For auth, versioning, and endpoint coverage, start with Get started with the Astro API and versioning and support.

Products

Jump directly into the part of the Astronomer platform you need to work with today.

Docs Home

Overview entry point for the full docs experience across managed, self-hosted, API, runtime, CLI, and learning content.

Astro

Product overviews, deployment workflows, observability, automation, networking, and administration guides.

Astro API

API overview pages plus generated reference from grouped OpenAPI specifications for supported versions.

Astro Private Cloud

Installation, upgrades, architecture, configuration, and version-specific operational guidance for private cloud deployments.

Astro Runtime

Runtime architecture, upgrade guidance, maintenance policy, provider package details, and release notes.

Astro CLI

Local development, project commands, authentication, deployment flows, and complete command reference.

Popular Paths

Common starting points for deploying pipelines, exploring the platform, and operating Astronomer environments.

Create your first Deployment

Provision your first Astro environment and walk through the managed onboarding flow.

Deploy code

Review the supported ways to move Airflow code from local development into Astro.

Manage workspaces

Configure workspaces, teams, tokens, and the core access model for your organization.

Use the Astro API

Authenticate, understand rate limits, and begin automating Astro resources through the REST API.

Run locally with the CLI

Initialize, test, and iterate on Astro projects from your local development environment.

Learn Airflow

Build foundational Apache Airflow knowledge with hands-on tutorials and conceptual explainers.

Resources

Get help, follow product updates, and stay connected to the broader Astronomer ecosystem.

Support

Read support guidance and use the documented support channels for Astro questions and operational help.

Community

Explore open-source projects, integrations, and developer tooling maintained by Astronomer.

Blog

Follow announcements, product updates, and technical content from the Astronomer team.

Ready to build?

Start with Astro if you want the fastest path to managed Airflow, or jump into Learn if you want to build your Airflow foundation first.