getting started

Install wflow

wflow is the open-source Wayland desktop automation engine. Rust core, Qt 6 / QML GUI, built on wdotool. Linux x86_64 only for now.

Prebuilt binary (recommended)

Fastest path. Download, chmod, run.

Download from GitHub Releases →

tar xf wflow-*-x86_64-linux.tar.zst
sudo install -m 0755 wflow /usr/local/bin/wflow
wflow doctor

wflow doctor reports whether wdotool, notify-send, and wl-copy are on PATH. Anything missing is the first thing to install.

Arch / AUR

yay -S wflow
# or
paru -S wflow

The AUR wflow package tracks GitHub Releases. For the bleeding edge, wflow-git builds from main.

Build from source

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

# Requires:
#   - rustup (Rust 1.77+)
#   - Qt 6.11+ (qt6-base, qt6-declarative, qt6-quickcontrols2)
#   - wdotool, notify-send, wl-copy on PATH

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

Compile takes a few minutes the first time (cxx-qt and the Qt bindings dominate). The binary lands in ~/.cargo/bin/wflow; make sure that's on PATH before you start the daemon.

wflow isn't published to crates.io yet, so cargo install --path . from a checkout is the only build-from-source path.

Once it's installed

Launch the GUI once with wflow — it writes the wflow://scheme handler so "Open in wflow" on workflow detail pages routes back to the desktop, and offers to enable the daemon's systemd user unit so chord triggers fire on every login.

For the long-running trigger daemon specifically, see Daemon & systemd. The short version is systemctl --user enable --now wflow-daemon if you didn't accept the auto-enable prompt.

Next

Write your first workflow →