Docs

The full reference lives in the repository. These notes get an app running and point at the right file.

Getting started

Install Rust and the native toolchain for your platform. Build, test and bundle from the repository root:

cargo test --all-targets
cargo run --release --bin ceri_bundle -- --output dist\windows-x64

The bundler reads the app's ceri.json. Only identifier is required:

{
  "identifier": "Ceri",
  "name": "Ceri",
  "resources": { "web": "assets/web", "sdk": "assets/sdk" }
}

To render one frame of an app to a PNG without opening a window, which CI does on every push:

ceri.exe "--ceri-assets=." "--ceri-entry=web/index.html" "--ceri-screenshot=app.png"

Add --ceri-scale=1.5 for a device pixel ratio other than 1. More in Build and Authoring.

Porting a Tauri app

The web side stays ordinary HTML, CSS and JavaScript. Most of a port is swapping imports and registering commands:

In TauriIn ceri
#[tauri::command]ceri::command! on App::json_command, arguments read by camelCase name
invoke, listen, emitThe same names from sdk/index.js
Capability filesCapabilities of Grants naming windows, origins and commands, deny by default
convertFileSrcfileSrc, once the app allows the folder
Window, dialog, opener, notification, autostart, global shortcut and deep link pluginsappWindow, dialog, opener, notification, autostart, globalShortcut, deepLink
Bundle settingsceri.json and ceri_bundle
App::new()
    .json_command("star", ceri::command!(|paths: Vec<PathBuf>, on: bool| star(&paths, on)))
    .json_command("owner", ceri::command!(|call| owner(&call.window)))
import { invoke, listen } from "./sdk/index.js";

const reply = await invoke("star", { paths, on: true });
const unlisten = await listen("progress", (event) => console.log(event.payload));

A call no grant allows is rejected inside the engine with code denied, before it reaches the app. The desktop's own commands, such as dialog:open, need a grant with a colon in it, so * never reaches them. The rules are under Commands; the types are in sdk/index.d.ts.

API coverage

The engine covers a bounded slice of the web platform. What is missing fails by name: an unsupported CSS rule is dropped and reported to the console, and an unsupported script surface throws a typed error.

  • HTML parsing and a live DOM, Shadow DOM, custom elements, Range and Selection, MutationObserver, ResizeObserver and IntersectionObserver.
  • CSS cascade layers, nesting, @container, @supports, block, flex, grid and table layout, transforms, transitions and animations, web fonts including WOFF2.
  • An ES2022 JavaScript engine of its own, with modules, import maps, workers, fetch, storage, IndexedDB and Web Crypto digests.
  • Canvas 2D, WebGL 1 and 2 on the CPU with its own GLSL compiler, and audio and video through the system decoders on Windows.
  • Production builds of Preact 11, Vue 3.5 and Svelte 5 run in its test suite.

Not covered yet: WebGPU, WebCodecs, multisampled WebGL, video on Linux, full WebAssembly, printing, platform accessibility adapters, and a sandboxed multi-process renderer. The full list is in the engine notes, and each open gate is in engine research.

Repository docs

  • README: building, bundling, commands, failure behavior.
  • Engine notes: every part of the platform the engine implements.
  • Architecture: process model, app origin, the runtime bridge, security boundaries.
  • Frames: how a frame is made and how to profile one.
  • Engine research: why ceri has its own engine, and the compatibility gates.