warp-pipe/docs/gui-usage.md
2026-01-31 11:21:28 -07:00

791 B

Warp Pipe GUI Usage

Build

cmake -S . -B build
cmake --build build

Disable the GUI target with -DWARPPIPE_BUILD_GUI=OFF.

Run

./build/warppipe-gui

Configuration

The GUI uses ConnectionOptions::config_path pointed at Qt's AppConfigLocation with /config.json appended. On Linux this is typically under ~/.config/Warppipe/config.json.

Command-line options

  • --screenshot <path>: capture a PNG screenshot and exit
  • --screenshot-delay <ms>: delay before capture (default 800)
  • --debug-screenshot-dir <dir>: save a timestamped screenshot on every graph update
  • --offscreen: run with QT_QPA_PLATFORM=offscreen
  • --help, --version

Shortcuts

  • F12: capture a screenshot to ~/Pictures/warppipe with a timestamp
  • Ctrl+Q: quit