Reel is a screen recorder for Omarchy. It lives in the bar, records a window, monitor, or selected area, and keeps your takes in a history you can open, trim with Omacut, or copy its path.
It uses gpu-screen-recorder for capture and keeps its state separate from
Omarchy's stock recorder, so both can be used without stepping on each other.
- Pick a window, monitor, or region with Omarchy's picker; recording starts after the countdown.
- Pause and resume without ending the file.
- Manual zoom during a take with touchpad pinch,
Ctrl+Altkeyboard binds, orCtrl+Scroll, capped at 2× by default. - Optional auto zoom in the save pass: clicks become smooth camera blocks, and
every take with telemetry writes an editable
project.jsoninto a hidden.reel/folder for re-rendering. - Optional click effects in the save pass: a premium theme-accent ripple or halo is drawn at each click, follows the auto zoom camera, and stays on the clicked content when manual zoom magnified a monitor take.
- Desktop audio, microphone, optional microphone noise reduction, pointer capture, 30/60/120 fps, quality presets, codec and resolution limits, MP4/MKV, and a webcam corner overlay with a camera picker.
- A bar mark for the resting, recording, paused, and closing states.
- Start the next take while earlier takes are still being saved; each save runs as its own job, so several can land beside a recording.
- Recording history with previews, open in
mpv, cut in Omacut, an actions menu with rename, share, and trash, path copy, and drag-out to drop the video into another app. Missing thumbnails are rebuilt from the take. - Keyboard-first panel.
- An update check: the panel header marks a waiting update and checks again on demand.
- Omarchy with the Quattro shell (
omarchy-shell). gpu-screen-recorderandffmpeg(which providesffprobe).- Omarchy's
omarchy-capture-regionpicker andslurpfor selection. grimfor still previews.mpvfor history playback and the webcam overlay.wl-clipboardfor the history path-copy action and bounded pastes in the name fields.- LocalSend for sharing takes through
omarchy share. - Optional:
omacutfor cutting takes. - Linux x86_64 for the prebuilt engine. Other architectures must build from source; see Development.
Install these with Omarchy's package installer: gpu-screen-recorder,
ffmpeg, grim, slurp, mpv, and wl-clipboard.
omacut is optional: takes still open in mpv without it, but the Cut action
needs it.
omarchy plugin add https://github.com/tahadx/reel --enable
~/.config/omarchy/plugins/io.github.tahadx.reel/install.shThe installer checks the core dependencies, links the reel command into
~/.local/bin, and enables the widget. It asks before adding optional
Hyprland shortcuts; --yes adds them and --no-binds skips them.
If omarchy-shell is not running when the installer reaches the plugin step,
it keeps going, restarts the shell at the end, and checks the plugin again once
the shell is up. If the shell still cannot answer, it says so and exits nonzero
instead of leaving the install half-finished without a message.
Stop an active take before installing or updating. A plugin reload tears down the panel process that keeps the recorder's telemetry listener alive; the take would keep recording without pointer data, so auto zoom would drop out for the rest of it. The installer refuses while Reel is recording or saving.
reel updateFrom an open panel, Shift+U runs the same command in a floating terminal, so
the updater and its shortcut prompt stay visible while the plugin reloads. The
update restarts the Omarchy shell at the end, so the new panel is loaded without
a manual omarchy-restart-shell.
Reel also checks for updates by itself: once when the shell starts and then once an hour. A waiting update shows as a newer version with an accent arrow in the panel header. That readout checks again when Reel is current, so a manual refresh never needs a terminal. The check contacts only the plugin's own git origin; a result is cached for the hour.
reel update runs omarchy plugin update io.github.tahadx.reel --yes, then runs
the installer from the freshly updated plugin checkout. The installer relinks
the reel command, rechecks dependencies, and restarts the Omarchy shell so the
new widget is loaded. It never downloads a second copy of the installer.
By default it leaves ~/.config/hypr/bindings.lua alone when the Reel block is
already there. If the block is missing, the installer asks before adding it.
Pass --binds to add or refresh the optional shortcuts without prompting:
reel update --bindsInstalls older than the update command need the two steps once:
omarchy plugin update io.github.tahadx.reel
~/.config/omarchy/plugins/io.github.tahadx.reel/install.shRe-running the installer is safe. It only writes the shortcut block when you
accept at the prompt or pass --yes; --no-binds skips it explicitly.
These are the shortcuts Reel offers to install. They are not set by
default: nothing is written to your Hyprland config unless you answer y at
the installer prompt or run it with --yes.
| Shortcut | Action |
|---|---|
Super + R |
Start or stop a take |
Super + Shift + R |
Open or close the Reel panel |
Super + Alt + O |
Pause or resume |
Ctrl + Alt + = / Ctrl + Alt + - |
Zoom in / out during a take |
Ctrl + Alt + 0 |
Reset zoom to 1× |
Ctrl + Alt + 8 |
Toggle between 1× and the zoom depth |
Ctrl + Scroll |
Zoom in / out during a take (no shortcut block needed) |
Ctrl + Alt + Scroll |
Zoom in / out during a take, from the optional shortcut block |
Ctrl + Alt + ←/→/↑/↓ |
Pan the zoomed view during a take (hold to keep moving) |
Ctrl + Alt + Shift + ←/→/↑/↓ |
Pan three times as far |
The full block, ready to copy, is in docs/bindings.md.
Touchpad pinch zoom needs no shortcut: Reel registers it at the start of each take. The zoom binds only act while a take is recording.
They are added as a marked block in ~/.config/hypr/bindings.lua; run
hyprctl reload after adding them. The block uses key names, so the shortcuts
follow the active keyboard layout. Delete the block to remove them.
If ~/.local/bin is not on your PATH, add it.
CLI options, files, uninstall, and troubleshooting are in docs/reference.md. The visual language is in docs/design.md.
Click the Reel mark in the bar to open the panel. Left-click toggles it, right-click starts or pauses, and middle-click opens the recordings folder.
- Press Record or click the preview.
- Click a window or monitor, or drag an area.
- After the countdown (0 by default), Reel records. The panel closes so it does not appear in the take.
Pause or resume from the panel, the bar's right-click action, or p. Open
history from the History tab in the panel's navigation strip, or with
Shift+H. Drag a take row into another app to copy the video file there.
Opening a take in mpv or cutting it in Omacut closes the panel; opening the
recordings folder does too.
A window is recorded as its visible screen rectangle, not an isolated toplevel surface. Overlapping windows and window movement can appear in the take. Monitors and dragged areas record exactly those screen pixels.
| Key | Action |
|---|---|
Shift+U |
Update Reel in a terminal |
↑ / ↓ or j / k |
Move between rows |
← / → or h / l |
Move horizontally; cycle the focused option |
Enter / Space |
Activate the selected action |
Tab / Shift+Tab |
Move between sections |
Esc |
Cancel the picker or countdown; go back, then close |
q |
Close the panel |
Shift+H |
Open or close history |
r |
Start or stop a take |
p |
Pause or resume |
d |
Discard the current take (press twice) |
s |
Open or close settings |
a |
Open the selected take's actions menu |
t |
Cut the selected take in Omacut |
x / Delete |
Trash the selected take (press twice) |
u |
Share the selected take with LocalSend |
n |
Rename the selected take |
c |
Copy the selected take's path |
o |
Open the recordings folder and close the panel |
Manual zoom is on by default (Settings → Manual zoom). It only acts while a take is recording; pausing or stopping resets the view to 1×.
- Touchpad pinch zooms at the pointer. Once already zoomed, a pinch that reads as a pan moves the viewport instead of changing the factor.
Ctrl + Alt + =/Ctrl + Alt + -zoom in and out,Ctrl + Alt + 0resets, andCtrl + Alt + 8toggles between 1× and the zoom depth.Ctrl + Scrollzooms in and out, smoothly, the same way a pinch does. Reel registers it when the take starts and removes it when the take ends, so Ctrl+scroll keeps its normal meaning in applications the rest of the time.Ctrl + Alt + Scrollalso works when the optional shortcut block is installed.- Monitor takes follow the pointer: moving the mouse pans the view and keeps the
cursor near the middle of the crop. Window and area takes keep the camera
detached, so the pointer stays where it really is instead of being pulled to
the screen centre and out of a small capture.
Ctrl + Alt + ←/→/↑/↓nudges a monitor take's view from the keyboard (hold to keep moving,Shiftfor a longer step). A nudge moves 60 px by default (reel config set panStep 30or120changes it). Panning never changes the zoom depth, and it stays inside the recorded monitor.
Zoom depth is 2× by default; reel config set zoomMax 1.5, 2.5, or 3
changes it. The keyboard and pan controls come from the optional shortcut
block; Ctrl + Scroll and touchpad pinch are registered by Reel when a take
starts. If you already have your own two-finger pinch binding, Reel overrides it
for the take and reloads your config afterwards so it comes back.
Noise reduction is off by default. Turn it on in Settings → Recording with the microphone enabled; Reel reduces steady background noise during the save pass, before the take is normalized. It only runs for takes that captured the microphone. It uses FFmpeg's noise reduction, so EasyEffects is not required.
Record the pointer lives in Settings → Visuals and controls pointer
capture. When it is on, Reel also keeps
local pointer telemetry for later save-pass work. That needs read access to
/dev/input; add your user to the input group and log in again. If the
devices cannot be read, the take still records without pointer telemetry.
Auto zoom sits below Manual zoom in Settings → Visuals, a single
on/off switch that is off by default. Turn it on and a press starts a short 2×
zoom block; a drag that begins with the press is followed smoothly until the
pointer settles. Every button press inside the capture counts, so selecting
text, moving a window, or scrubbing a slider zooms and keeps the pointer in
frame. Clicks outside a window or area take are ignored, and the zoomed crop is
always clamped inside the capture. When a press only focuses a window, the
block follows the part of the screen that changes — the text you are typing and
the caret next to it — instead of zooming into an empty area.
The pointer is still recorded in this version and scales with the zoom. Reel
needs read access to /dev/input to see the clicks; without it the take still
saves, just without the automatic zoom. If the camera pass itself fails, the
take is still saved without the zoom and the reason stays in the recorder log.
Click effects sits below Auto zoom in Settings → Visuals. It is off
by default; pick Ripple or Halo to draw a premium theme-accent effect at
every click in the saved file. Ripple is the signature ring and glow, Halo is a
soft lens-like bloom. Effects are drawn for short taps — released within 280 ms
and within 15 px — so a drag zooms without drawing an effect. The effects are
built in the save pass from the same pointer telemetry as auto zoom, need
Record the pointer on, and follow the camera when a click zooms. The active
Omarchy accent is used, with a dark hairline so the effect reads on both light
and dark content. The choice is stored in the take's project.json, so
reel render reproduces the same effect even after a theme change.
Every saved take with telemetry writes a project.json into a hidden .reel/
folder beside it, even when auto zoom is off. The folder is owner-only and its
files are removed when the take is trashed. reel render --project <path>
renders the take again with the camera path in that file. The default output is
<take-stem>.rendered.<ext>, and the original take is never replaced. The
project schema and the keyframe fields are in
docs/reference.md.
The settings page covers all capture options and the filename prefix. History
takes open in mpv; Cut sends the selected take to Omacut for trimming.
Takes are saved in the recordings folder, ~/Videos/Reel by default. Closing
the panel with q or Esc does not stop an active take; use r or the stop
action.
Build and test from the repository root:
cargo build --release
cargo test --workspace
bin/lint-qml
bin/test-qmlThe plugin ships bin/dist/reel-native, so users do not need a Rust toolchain.
Release builds and architecture notes cover
bin/refresh-dist and the release process. Agent instructions live in
docs/contributing/agent-guide.md; they are
not a root AGENTS.md/CLAUDE.md because the plugin directory is copied
verbatim at install time.
Reel is MIT. The static engine also links third-party crates, the Rust standard
library, and musl; their notices are mapped in
THIRD-PARTY.md and shipped under licenses/. The development
install copies the notices into the installed plugin tree, and the release
workflow publishes them as a reel-<version>-licenses.tar.gz asset beside the
standalone engine.