Skip to content
ElygPublic

About

Review images (exr, png, jpeg), in the terminal or via ssh with ACES support, annotations, diff, tiling for reviewing images

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

rega

Terminal image browser/viewer for OpenEXR (layers, AOVs, sequences), TIFF, PNG, JPEG, MOV and MP4. Draws images with the kitty graphics protocol, or half-blocks on any terminal, or in a window of its own (rega --gui).

rega (reh-GAH, /rʲɛˈɡɐ/): Lithuanian for "sight".

Features with a short clip · terminal and tmux setup · colour (OCIO, ACES) · keybinds

Demo

intro.mp4

Usage

rega                      # browse the current directory
rega shots/               # browse a directory
rega 'shot.####.exr' ...  # view sequences
rega 'shot.#.exr'         # a lone # finds the padding itself
rega --diff old.exr new.exr ...    # A, B and |A - B| side by side; n / p: next pair
rega a.exr:label=top:main ...      # a label on the image (tl tc tr bl bc br, top, bottom)
rega --dump foo.exr       # print layers, channels and metadata
rega --doctor             # check the terminal / tmux setup
rega --tutorial           # a guided tour on sample images (rendered into ~/.cache/rega/tutorial)
rega --gui                # a window of its own: open, paste or pick recent files to start

In the browser, mark two images (space) and press d to diff them; with more marked, they pair up in marking order (1st with 2nd, 3rd with 4th, …).

Supported terminals

  • Ghostty, kitty: full-resolution images.
  • Any other terminal: ▦ half-blocks, a coarser fallback where each character cell shows 2 pixels.

rega detects which one to use. To choose yourself: --graphics kitty or --graphics halfblock.

Install

Linux and macOS

curl -fsSL https://raw.githubusercontent.com/Elyg/rega/main/scripts/install.sh | bash

scripts/install.sh puts the latest release into ~/.local/bin: a fully static binary on Linux (x86_64, aarch64; any distro, no dependencies), or the Apple Silicon build on macOS. To pin a release or pick another folder, set them for bash: … | REGA_VERSION=0.0.15 REGA_BIN_DIR=~/bin bash. On NixOS, use the flake instead (below).

The script checks the download against the release's SHA256SUMS before installing anything. Each release also carries a build provenance attestation: to check a tarball yourself, gh attestation verify rega-<version>-<platform>.tar.gz -R Elyg/rega.

Nix, Home Manager and pinning a release: Install.

Setup

Ghostty and kitty just work, directly or over ssh. In tmux, add set -g allow-passthrough on. rega --doctor says what's missing. Every case (tmux before or after ssh, other terminals): Terminal setup.

Learn more

rega --tutorial walks you through sample images. The user guide covers the browser, the viewer, its panes, colour (OCIO), annotations and every key.

Build from source

Prerequisites:

  • Nix with flakes enabled. Its dev shell provides just, cmake, ninja, conan and clang-format/clang-tidy, so there's nothing else to install.
  • direnv (optional): enters the dev shell automatically on cd (direnv allow once). Without it, run nix develop.
  • macOS: Xcode Command Line Tools (xcode-select --install); the build uses Apple clang.

Then:

just build        # conan deps + configure + build
just run demos/   # build and run
just test         # unit tests
just              # list every recipe

Development

Developed with assistance from Claude Code. All changes are reviewed, tested, and maintained by me.

Licence

rega is under the MIT licence. The notices for the libraries in its release binaries are in licenses/ and in each release tarball.

The binaries include FFmpeg, used under the LGPL 2.1 or later with no GPL or non-free parts. Each release attaches FFmpeg's exact source, and licenses/FFMPEG-BUILD.txt lists how it's built and how to rebuild rega with your own.

About

Review images (exr, png, jpeg), in the terminal or via ssh with ACES support, annotations, diff, tiling for reviewing images

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages