Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command line

rega [OPTIONS] [paths...]

Paths

ArgumentOpens
(none)the browser, in the current folder
shots/the browser, in that folder
render.exrthe viewer, on that image
'shot.####.exr'the viewer, on the sequence (each # one digit)
'shot.#.exr'the sequence, whatever its padding
a.exr b.exr …the viewer, on all of them (n / p step)
a.exr:label=top:mainthe image, with a label

Quote patterns with # so the shell leaves them alone. A plain frame path (shot.1001.exr) opens just that frame.

Options

OptionDoes
--diff A Bcompare A with B: A, B and |A − B| tiled. Repeat for more pairs; paths can carry labels. See Compare
--dump FILEprint the layers, channels and metadata, then exit
--doctorcheck the terminal and tmux setup for images and copy, then exit (1 if a check fails). See Terminal setup
--guiopen in a window of its own instead of the terminal (not in the static Linux binary; on Windows always)
--tutorialrender the sample images into ~/.cache/rega/tutorial (first run) and open them with a guide. See tutorial
--graphics MODEauto (default), kitty or halfblock. See setup
--transfer MODEhow kitty images reach the terminal: auto (default) picks shm (shared memory) locally outside tmux, file (temp files) in tmux, direct (inline) over ssh. Change it only if images stay blank
--link-rate SIZEbytes a second the ssh link is assumed to carry until measured, e.g. 20M; playback sending images inline is paced to the link (default 4M, 0: unpaced, unmeasured)
--terminal-cache SIZEterminal image memory frames played over ssh may keep there, e.g. 512M: a loop’s second pass sends no pixels (default 256M, under kitty’s and Ghostty’s 320 MB; 0: off)
--cache SIZEmemory for decoded images, e.g. 8G or 512M (default 4G, at least 64M)
--chooser-file FILEo in the browser writes the chosen paths to FILE and exits. See picking files
--cwd-file FILEon exit, write the last folder to FILE
--versionprint the version and licence notice
-h, --helpprint the options

Files rega keeps

PathWhat
~/.cache/rega/tutorial/the tutorial’s images
~/.local/state/rega/annotationsannotations, between sessions
~/.local/state/rega/colourthe colour choices, per config
~/.local/state/rega/backdropthe backdrop
~/.local/state/rega/windowthe window’s size, text size and last folder
~/.local/state/rega/recentthe window’s recent items

$XDG_CACHE_HOME and $XDG_STATE_HOME move them. They, and the log (~/.cache/rega/rega.log, or $REGA_LOG), name the files viewed, so rega creates them readable by their owner only.

Environment

VariableEffect
OCIOthe OpenColorIO config to show images through
REGA_LOCAL_ONLY1: for sites where images must stay on the machine holding them. rega refuses to run over ssh, where frames and copied text go to the terminal’s machine, and never copies to the terminal’s clipboard (in tmux, copies stay in tmux’s buffer)
REGA_MAX_MEGAPIXELSthe largest frame rega will load, in megapixels (default 1024); a file’s header can claim any size
LC_TERMINALnames the terminal behind a tmux on the other side of ssh (ghostty, kitty): turns kitty graphics on there