Skip to main content

airflowctl

A command-line tool for interacting with Apache Airflow instances through the Airflow REST API. It offers a convenient interface for performing common operations remotely without direct access to the Airflow scheduler or webserver.

Features

  • Communicates with Airflow instances through the REST API
  • Supports authentication using Airflow API tokens
  • Executes commands against remote Airflow deployments
  • Provides intuitive command organization with group-based structure
  • Includes detailed help documentation for all commands

Requirements

  • Python 3.10 or later (compatible with 3.10 <= Python <= 3.14)
  • Network access to an Apache Airflow instance with REST API enabled
  • [Recommended] Keyring backend installed in operating system for secure token storage.
    • In case there's no keyring available (common in headless environments) you can provide the token to each command. See the Security page for more information.

Usage

Access the tool from your terminal:

Command Line

airflowctl --help

Contributing

Want to help improve Apache Airflow? Check out our contributing documentation.

Additional Contribution Guidelines

  • Please ensure API is running while doing development testing.
  • There are two ways to have a CLI command,
    • Auto Generated Commands
    • Implemented Commands

Auto Generated Commands

Auto generation of commands directly from operations methods under airflow-ctl/src/airflowctl/api/operations.py. Whenever operation is mapped with proper datamodel and response model, it will be automatically added to the command.

You can check each command with airflowctl <command> --help to see the available options.

Implemented Commands

Implemented commands are the ones which are not auto generated and need to be implemented manually. You can check the implemented commands under airflow-ctl/src/airflowctl/ctl/commands/.

Metadata

Release files for apache-airflow-ctl 0.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apache-airflow-ctl 0.1.6
File Size Uploaded Provenance Actions
apache_airflow_ctl-0.1.6.tar.gz 214.3 kB Without provenance Details for apache_airflow_ctl-0.1.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apache-airflow-ctl 0.1.6
File Interpreter ABI Platform Actions
apache_airflow_ctl-0.1.6-py3-none-any.whl Python 3 none any Details for apache_airflow_ctl-0.1.6-py3-none-any.whl

Total release size: 296.3 kB

Release files / apache_airflow_ctl-0.1.6.tar.gz

Download URL apache_airflow_ctl-0.1.6.tar.gz
Size 214.3 kB
Tags Source
SHA-256 checksum
How to use checksums
dae7060470e3cb5ecc10c139889c2bd10aade3ee5c38135abd3244907d679dcc
BLAKE2b-256 checksum
How to use checksums
37332085d37911719421316c1905ea411a71ca901759af408bd850e568f64403
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release files / apache_airflow_ctl-0.1.6-py3-none-any.whl

Download URL apache_airflow_ctl-0.1.6-py3-none-any.whl
Size 82.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0967b39cb5fa5ecd5fa2db93d1c63e1fd2e077fc17a763bc2fa13f43a1575649
BLAKE2b-256 checksum
How to use checksums
d01fea7e5791707a06d46281c0243ccc0dc049a25ee3d267d0540ffc6e2407a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Security for apache-airflow-ctl 0.1.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page