engine · install

Install wflow.

wflow is the open-source Wayland desktop automation engine that runs the .kdl files you find on this site. Rust core, Qt Quick GUI, built on wdotool. One binary, three install paths.

Prebuilt binary (recommended)

Linux x86_64. The fastest path: download, chmod, run.

Download from GitHub Releases

# After download:
chmod +x wflow-*-linux-x86_64
sudo mv wflow-*-linux-x86_64 /usr/local/bin/wflow

# Verify:
wflow doctor

wflow doctor tells you whether your Wayland compositor, wdotool, and the GUI dependencies are all wired up. If anything's missing it'll point you at what to install.

Arch / AUR

If you're on Arch or a derivative, the AUR package tracks releases.

yay -S wflow
# or
paru -S wflow

Maintained by @cushycush in sync with GitHub Releases. Open an issue on the repo if a release lags more than a day.

Build from source

For other distros, edge versions, or hacking on the engine.

# Requires rustup, Qt 6.5+, wdotool

git clone https://github.com/cushycush/wflow
cd wflow
cargo install --path .

# Or just install the published version:
cargo install wflow

Compile takes ~3 minutes on a modern laptop. The Qt dependency is the heavy part — make sure qt6-base-dev (or equivalent) is installed before cargo install runs.

Once it's installed

Run wflow daemon in the background (or set up the systemd user service — see the readme for the unit file).
Click Open in wflow on any workflow card here. The first time, your browser will ask if you want to allowwflow:// URLs to open the wflow app — say yes.
The workflow lands in your local library, ready to fire on whatever trigger it specifies.

Stuck? Ask in Discord or read the docs.