<br />

<br />


[Managed Airflow (Gen 3)](https://docs.cloud.google.com/composer/docs/composer-3/access-airflow-cli "View this page for Managed Airflow (Gen 3)") \| [Managed Airflow (Gen 2)](https://docs.cloud.google.com/composer/docs/composer-2/access-airflow-cli "View this page for Managed Airflow (Gen 2)") \| **Managed Airflow (Legacy Gen 1)**

<br />

<br />

<br />

<br />

<br />

<br />

Apache Airflow has a command-line interface (CLI) that you can use to perform
tasks such as triggering and managing DAGs, getting information about DAG runs
and tasks, adding and deleting connections and users.

## Supported Airflow CLI commands

<br />

Airflow in Managed Airflow (Legacy Gen 1) provides two different syntaxes for CLI commands:

- [Airflow 1.10 CLI syntax](https://airflow.apache.org/docs/apache-airflow/1.10.12/cli-ref.html),
  available in Managed Airflow environments with Airflow 1.10.

- [Airflow 2 CLI syntax](https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html),
  available Managed Airflow environments with Airflow 2.

For a full list of supported Airflow CLI commands, see the reference for the
[`gcloud composer environments run`](https://docs.cloud.google.com/sdk/gcloud/reference/composer/environments/run#SUBCOMMAND) command.

## Before you begin

For executing Airflow CLI commands through Google Cloud CLI:

- Your Google Account must have [permissions](https://docs.cloud.google.com/composer/docs/composer-1/access-control#cli) to use
  Google Cloud CLI with Managed Airflow and run Airflow CLI
  commands.

  > [!CAUTION]
  > **Caution:** Users with the `composer.environments.executeairflowcommand` permission can execute Python code available to Airflow components on behalf of the environment's service account. For more information, see [Access control](https://docs.cloud.google.com/composer/docs/composer-1/access-control#service-account-security).

- Airflow CLI commands executed through Google Cloud CLI consume the
  `environments.executeAirflowCommand` [quota](https://docs.cloud.google.com/composer/quotas).

  > [!IMPORTANT]
  > **Important:** If you want to trigger a large number of DAGs, we recommend to do it [with Airflow REST API](https://docs.cloud.google.com/composer/docs/composer-1/access-airflow-api#call-api). Triggering DAGs through Google Cloud CLI might cause your environment to reach the quota limit, and as a result, Airflow CLI commands will no longer be executed.

## Run Airflow CLI commands with gcloud CLI

To run Airflow CLI commands in your environments, use gcloud CLI:

    gcloud composer environments run ENVIRONMENT_NAME \
        --location LOCATION \
        SUBCOMMAND \
        -- SUBCOMMAND_ARGUMENTS

Replace the following:

- `ENVIRONMENT_NAME`: the name of your environment.
- `LOCATION`: the region where the environment is located.
- `SUBCOMMAND`: one of the [supported Airflow CLI commands](https://docs.cloud.google.com/sdk/gcloud/reference/composer/environments/run#SUBCOMMAND).
- `SUBCOMMAND_ARGUMENTS` with arguments for the Airflow CLI command.

### Sub-command arguments separator

Separate the arguments for the specified Airflow CLI command with `--`:

<br />

### Airflow 2


- Specify compound CLI commands as a sub-command.
- Specify any arguments for compound commands as sub-command arguments, after a `--` separator.

Example:

    gcloud composer environments run example-environment \
        dags list -- --output=json

<br />

### Airflow 1


- Specify CLI commands as a sub-command.
- Specify any arguments after a `--` separator.

Example:

    gcloud composer environments run example-environment \
        list_dags -- --report

<br />

### Default location

Most `gcloud composer` commands require a location. You can specify the
location with the `--location` flag, or by
[setting the default location](https://docs.cloud.google.com/composer/docs/gcloud-installation#set-default).

For example, to trigger a DAG named `sample_quickstart` with the ID `5077` in
your Managed Airflow environment:

<br />

### Airflow 2


    gcloud composer environments run example-environment \
        --location us-central1 dags trigger -- sample_quickstart \
        --run-id=5077

<br />

### Airflow 1


    gcloud composer environments run example-environment \
        --location us-central1 trigger_dag -- sample_quickstart \
        --run_id=5077

<br />

## What's next

- [Access Airflow UI](https://docs.cloud.google.com/composer/docs/composer-1/access-airflow-web-interface)
- [Access control (Airflow CLI)](https://docs.cloud.google.com/composer/docs/composer-1/access-control#cli)