Revela

Installation

Revela runs on Windows, macOS, and Linux. It comes in three editions. If you just want to publish your photos, pick Standalone.

Standalone (recommended) Full .NET Global Tool
Prerequisites None None .NET 10 SDK
Plugins & themes All built in Installed from the bundled packages/ folder Installed from release .nupkg files
Plugin/theme management Not needed (not available) revela plugin …, revela theme install …, revela restore Same as Full
Custom plugins ❌ ✅ ✅

The Downloads page has direct links for every edition.


A single executable with the Lumina theme, its Statistics and Calendar extensions, and all six official plugins (Compress, Serve, Statistics, Calendar, Source.OneDrive, Source.Calendar) built in. There is nothing to install afterwards and no internet connection is needed to build your site.

The easiest way is the Downloads page, or the newest release on GitHub Releases. Extract the archive into a folder of your choice.

Beta note: every Revela release is currently a pre-release, so GitHub's /releases/latest/ links don't work yet. The commands below look up the newest release first.

Windows (x64)

In PowerShell:

$tag = (Invoke-RestMethod https://api.github.com/repos/Spectara/Revela/releases)[0].tag_name
Invoke-WebRequest "https://github.com/Spectara/Revela/releases/download/$tag/revela-win-x64-standalone.zip" -OutFile revela.zip
Expand-Archive revela.zip -DestinationPath D:\Revela

macOS (Apple Silicon)

TAG=$(curl -s https://api.github.com/repos/Spectara/Revela/releases | grep -m1 '"tag_name"' | cut -d '"' -f4)
curl -L "https://github.com/Spectara/Revela/releases/download/$TAG/revela-osx-arm64-standalone.tar.gz" | tar xz
chmod +x revela

Linux (x64)

TAG=$(curl -s https://api.github.com/repos/Spectara/Revela/releases | grep -m1 '"tag_name"' | cut -d '"' -f4)
curl -L "https://github.com/Spectara/Revela/releases/download/$TAG/revela-linux-x64-standalone.tar.gz" | tar xz
chmod +x revela

Keep the native library that comes in the archive (libvips-42.dll, libvips.42.dylib or libvips.so.42) next to the executable. Builds for Windows ARM64 and Linux ARM64 are also on the releases page.

Tip: Add the folder that contains revela to your PATH, so you can run revela from any project folder.


Full (Modular)

The revela executable plus a packages/ folder with every official plugin and theme as a .nupkg file. Revela uses that folder as an offline package feed named bundled, so you choose which plugins and themes to install, and you can add third-party or your own plugins.

Download revela-<platform>-full.zip (Windows) or revela-<platform>-full.tar.gz (macOS/Linux) from the releases page and extract it. Keep the packages/ folder next to the executable.

On first run, Revela starts the Setup Wizard, which installs themes and plugins from packages/. Choose Full Installation to install everything, or Custom Installation to pick packages. Revela exits after installing; start it again to continue. You can install or remove packages later:

revela plugin install Statistics
revela theme install Lumina.Statistics
revela plugin list

See Plugins for details.


.NET Global Tool

If you have the .NET SDK (version 10 or later), you can install Revela as a global tool.

Not on NuGet.org yet: Revela packages are not published on NuGet.org, so dotnet tool install -g Spectara.Revela on its own will fail. Every package is attached to each GitHub Release instead.

  1. Download Spectara.Revela.<version>.nupkg from the release into a folder, for example ./revela-packages. Download the plugin and theme .nupkg files you want into the same folder (at least Spectara.Revela.Themes.Lumina.<version>.nupkg).

  2. Install the tool from that folder:

    dotnet tool install -g Spectara.Revela --version <version> --add-source ./revela-packages
    
  3. Tell Revela where to find plugins and themes (the tool has no bundled packages):

    revela config feed add releases /absolute/path/to/revela-packages
    

    This adds the folder to dependencies.feeds in your global revela.json, so it is trusted for every project.

The tool has the same commands as the Full edition.


First Run

Revela always works on the current folder: the folder you start it in is your project. To create a site:

  1. Create an empty folder for your site, for example D:\Photos\MyPortfolio.

  2. Open a terminal in that folder and run revela. (If you double-click the executable or the Start Revela launcher instead, the folder that contains Revela becomes the project.)

  3. Revela finds no project.json and offers Create New Project. The project wizard asks for:

    1. Project settings (name, base URL)
    2. Directory paths (source and output by default)
    3. Theme (Lumina)
    4. Image settings (formats and quality)
    5. Site metadata (title, author, …)

    It then offers optional steps, such as connecting a OneDrive folder.

  4. Put your photos in source/ and choose generate → all.

The wizard creates project.json and site.json in the folder. The User Journey walks through the whole workflow.

Full edition and .NET tool: on the very first start, the Setup Wizard installs themes and plugins before the project wizard runs.


Verifying Installation

revela --version

For more detail (plugin and theme counts, active theme):

revela info

The version line ends with the edition, for example — Standalone edition or — Full edition.

Check where Revela stores its configuration:

revela config locations

The global revela.json lives next to the executable when that folder is writable (for example an extracted ZIP). Otherwise it goes to %APPDATA%\Revela\ on Windows or ~/.config/Revela/ on macOS and Linux.


Updating

Standalone

Download the latest release and replace the executable (and the native libvips library next to it). Your projects are ordinary folders and are not touched. Themes and plugins are built in, so they update with the executable.

Full

Extract the new release over the old one, including the new packages/ folder. Then run this in each project to install the matching versions:

revela restore

.NET Global Tool

Download the new release's .nupkg files into your package folder, then:

dotnet tool update -g Spectara.Revela --version <version> --add-source ./revela-packages
revela restore

After an update

Revela keeps a manifest of scanned photos in .revela/core/. When a new version changes its format, Revela discards the old manifest and the next revela generate all rescans your photos (reading their metadata again). Images are not re-encoded for that: Revela tracks processed images separately in .revela/core/images.json and only re-encodes a photo when something that changes its output changed — its source file, sizes, formats, quality, or a Revela update to how images are encoded (the release notes say so when that happens).

Troubleshooting

revela: command not found

Revela isn't on your PATH.

Permission denied (macOS / Linux)

The binary isn't executable yet:

chmod +x /path/to/revela

Windows SmartScreen warning

The executable isn't code-signed yet. Click More info → Run anyway.

macOS "cannot be opened because the developer cannot be verified"

Allow it once under System Settings → Privacy & Security → Open Anyway, or clear the quarantine flag from the terminal:

xattr -d com.apple.quarantine /path/to/revela

Something else looks wrong

Run this inside your project folder:

revela check

It checks configuration, folder structure, theme and content, and tells you how to fix each problem.