Prerequisites¶

airflowctl is tested with:

The minimum memory required we recommend airflowctl to run with is 200MB, but the actual requirements depend wildly on the deployment options you have. The Keyring backend needs to be installed separately into your operating system. This will enhance security. See Security for more information.

Keyring Backend [Recommended]¶

airflowctl uses keyring to store the API token securely. This ensures that the token is not stored in plain text and is only accessible to authorized users.

Recommended keyring backends are:

macOS Keychain
Freedesktop Secret Service supports many DE including GNOME (requires secretstorage)
KDE4 & KDE5 KWallet (requires dbus)
Windows Credential Locker

In case there’s no keyring available (common in headless environments) you can provide the token to each command. See Security for more information.

Third-Party Backends¶

In addition to the backends provided by the core keyring package for the most common and secure use cases, there are additional keyring backend implementations available for other use cases. Simply install them to make them available:

keyrings.cryptfile
- Encrypted text file storage.
keyrings.alt
- “alternate”, possibly-insecure backends, originally part of the core package, but available for opt-in.
gsheet-keyring
- a backend that stores secrets in a Google Sheet. For use with ipython-secrets.
bitwarden-keyring
- a backend that stores secrets in the BitWarden password manager.
onepassword-keyring
- a backend that stores secrets in the 1Password password manager.
sagecipher
- an encryption backend which uses the ssh agent protocol’s signature operation to derive the cipher key.
keyrings.osx_keychain_keys
- OSX keychain key-management, for private, public, and symmetric keys.
keyring_pass.PasswordStoreBackend
- Password Store (pass) backend for python’s keyring
keyring_jeepney
- a pure Python backend using the secret service DBus API for desktop Linux (requires keyring<24).

Python Version Compatibility¶

airflowctl is compatible with versions of Python 3.10 through Python 3.14. Currently, Python 3.14 is not supported. Thanks for your understanding! We will work on adding support for Python 3.14.

Python Version	Supported
3.10	Yes
3.11	Yes
3.12	Yes
3.13	Yes
3.14	No