flowrs

(โ˜… 172)

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

  • .coderabbit.yaml
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CLAUDE.md
  • clippy.toml
  • CODE_OF_CONDUCT.md
  • dist-workspace.toml
  • docker-compose.yaml
  • LICENSE
  • Makefile
  • README.md
  • release-plz.toml

# Installation Guide

1. Get the code
git clone https://github.com/jvanbuel/flowrs

Downloads the entire project code from GitHub to your computer.

cd flowrs

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
brew install flowrs

Installs the pre-built package via Homebrew โ€” no source build required.

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

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

cargo install flowrs-tui --locked

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install flowrs-tui --locked

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation