quickshell(1)

💅 quickshell — from the General Commands Manual, bestie

okay so picture this: it's a manual page, it's called quickshell(1), it lives in the General Commands Manual section, and it's here to install the Quickshell QML tree for the voxtype-osd-quickshell launcher. that's it. that's the whole vibe. 🦋

---

✨ NAME ✨

quickshell — install the Quickshell QML tree for the voxtype-osd-quickshell launcher 🎀

---

🌸 SYNOPSIS 🌸

quickshell [--target] [--source] [--force] [--print-bindings] [--bridge]
[--bridge-target] [--skip-bridge] [-h|--help]

---

💖 DESCRIPTION 💖

so what does it do, you ask? it installs the Quickshell QML tree for the voxtype-osd-quickshell launcher. genuinely that simple, and honestly? iconic.

here's the tea: it copies shell.qml, OsdSurface.qml, EnginePicker.qml, MeetingControls.qml, and the voxtype-shared module into $XDG_DATA_HOME/voxtype/quickshell/ — or, if XDG_DATA_HOME isn't set, into ~/.local/share/voxtype/quickshell/. 🫶

then, because it's an overachiever, it prints Hyprland/Sway/River keybinding examples for the Wave 2 engine-picker and meeting-controls trigger flags. slay. no cap. ⭐

---

🔥 OPTIONS 🔥

• --target <DIR> — overrides the install target directory. yes, you get to pick where it lands 💅
• --source <DIR> — overrides the QML source directory. if you don't pass it, it auto-detects, and the search order is literally this:
  1. $VOXTYPE_QUICKSHELL_SOURCE_DIR
  2. <binary>/../share/voxtype/quickshell/
  3. /usr/share/voxtype/quickshell/
  4. ./quickshell/
• --force — overwrites an existing install at the target. only if you mean it, bestie 😭
• --print-bindings — skips the file copy entirely and only prints the compositor binding examples. all the info, none of the writing-to-disk. lowkey the safest option fr fr 🌈
• --bridge <PATH> — overrides the source path of the voxtype-audio-bridge binary. when you omit it, the search order is:
  1. $VOXTYPE_AUDIO_BRIDGE_BINARY
  2. <binary>/../lib/voxtype/voxtype-audio-bridge
  3. /usr/lib/voxtype/voxtype-audio-bridge
  4. which voxtype-audio-bridge
  5. target/release/voxtype-audio-bridge
  6. target/debug/voxtype-audio-bridge
• --bridge-target <PATH> — overrides the symlink location for voxtype-audio-bridge. it defaults to $XDG_BIN_HOME/voxtype-audio-bridge or ~/.local/bin/voxtype-audio-bridge.

⚠️ heads up: it must live under the user's $HOME unless you also pass --force. the way that's a whole rule, not a suggestion 💀

• --skip-bridge — skips installing the voxtype-audio-bridge symlink. use this if the bridge is already on PATH — like, a packaged install put it there, or you've got your own symlink doing its little thing 🧚
• -h, --help — prints help. and note the little whisper in the original: it's "see a summary with '-h'" — so yes, the short one gives you the summary version 👑

---

🎀 that's a wrap 🎀

and that's the page, bestie — straight from the quickshell source, the quickshell(1) manual. go forth and install something gorgeous 💜✨ 🦋