Using the Command Line Interface

This document is meant to give an overview of all common tasks while using the CLI.

Set Up connection to a remote Airflow instance

For some functions the CLI can use the REST API. To configure the CLI to use the API when available configure as follows:

api_client = airflow.api.client.json_client
endpoint_url = http://<WEBSERVER>:<PORT>

Set Up Bash/Zsh Completion

When using bash (or zsh) as your shell, airflow can use argcomplete for auto-completion.

For global activation of all argcomplete enabled python applications run:

sudo activate-global-python-argcomplete

For permanent (but not global) airflow activation, use:

register-python-argcomplete airflow >> ~/.bashrc

For one-time activation of argcomplete for airflow only, use:

eval "$(register-python-argcomplete airflow)"

If you’re using zsh, add the following to your .zshrc:

autoload bashcompinit
eval "$(register-python-argcomplete airflow)"