flowrs

Open source

Flowrs is a TUI application for Apache Airflow that allows you to monitor, inspect and trigger Airflow DAGs from the comforts of your terminal.

172 stars0 likes0 views

Website GitHub

About

Flowrs is a TUI application for Apache Airflow that allows you to monitor, inspect and trigger Airflow DAGs from the comforts of your terminal.

Flowrs is a TUI application for Apache Airflow. It allows you to monitor, inspect and manage Airflow DAGs from the comforts of your terminal. It is build with the ratatui library.

Installation

You can install flowrs via Homebrew if you're on macOS / Linux / WSL2:

bash

brew install flowrs

or with uv on macOS (Apple silicon and Intel) and Linux x86_64:

bash

uv tool install flowrs

You can also download the binary directly from GitHub:

bash

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/jvanbuel/flowrs/releases/latest/download/flowrs-tui-installer.sh | sh

Alternatively, you can build flowrs from source with cargo:

bash

cargo install flowrs-tui --locked

Usage

Managed Airflow services

The easiest way to user flowrs is with a managed Airflow service. The currently supported managed services are:

Conveyor
Amazon Managed Workflows for Apache Airflow (MWAA)
Google Cloud Composer
Astronomer

To enable a managed service, run flowrs config enable -m . This will add the configuration for the managed service to your configuration file, or prompt you for the necessary configuration details. On startup flowrs will then try to find and connect to all available managed service's Airflow instances.

Note that for Astronomer, you need to set the ASTRO_API_TOKEN environment variable with your Astronomer API token (Organization, Workspace or Deployment) to be able to connect to the service.

Custom Airflow instances

If you're self-hosting an Airflow instance, or your favorite managed service is not yet supported, you can register an Airflow server instance with the flowrs config add command:

This creates an entry in your configuration file at $XDG_CONFIG_HOME/flowrs/config.toml (following the XDG Base Directory Specification, which defaults to ~/.config/flowrs/config.toml). For backwards compatibility, flowrs also reads from ~/.flowrs if the XDG location doesn't exist. If you have multiple Airflow servers configured, you can easily switch between them in flowrs configuration screen.

Flowrs supports authenticating with HTTP Basic Auth or using bearer tokens. When selecting the bearer token option, you can either provide a static token or a command that generates a token.

Themes

Flowrs ships with six themes, including four Catppuccin flavors. The active theme is configured with flowrs config --theme :

Theme	Description
`auto`	Detects your terminal background and picks dark or light (default)
`dark`	Dark theme
`light`	Light theme
`catppuccin-latte`	Catppuccin Latte (light)
`catppuccin-frappe`	Catppuccin Frappé (medium-dark)
`catppuccin-macchiato`	Catppuccin Macchiato (dark)
`catppuccin-mocha`	Catppuccin Mocha (darkest)