CLI Reference
The orcli command-line tool manages OpenReality projects, builds, exports, and provides an interactive TUI dashboard.
# Installation
# Quick Start
# orcli init
Initialize a new OpenReality project. Use --engine-dev to clone the full engine repo for development.
# orcli run
Run a Julia scene or script. The optional --warm-cache flag pre-compiles all shaders before launching.
# orcli build
Build targets for various platforms. Supports GPU backends, desktop executables, web deployment, and mobile (experimental).
# orcli export
Export a scene to a portable format. Supports orsb (OpenReality Scene Bundle) and gltf (glTF 2.0).
# orcli package
Package a built application for distribution. Run after orcli build to create distributable archives.
# orcli cache
Manage the shader cache. Pre-compile shaders for faster startup, or clear stale cache entries.
# orcli update
Pull latest engine changes and sync Julia dependencies. For engine dev projects, pulls in the project root. For user projects, pulls in the engine dependency directory.
# orcli setup
Manage the Julia package environment. Install dependencies, check status, or update packages.
# orcli info
Show project info, detected tools, backend status, and available examples. Prints the same information displayed in the TUI Dashboard tab.
# TUI Guide
Launch the TUI by running orcli with no arguments. The interface has five tabs navigable with Tab / Shift-Tab or keys 1-5.
Dashboard
Displays project info, detected tools, Julia package status, and discovered examples. Press n to create a new scene.
Build
Build GPU backends and view build logs. Switch modes with a (backend), d (desktop), w (web), m (mobile), x (export), p (package). Press Enter or b to start a build.
Run
Run example scenes. Select with j/k, switch backend with h/l, toggle warm cache with c, and run with Enter or r.
Setup
Manage Julia dependencies and shader cache. Includes Install, Status, Update, Warm Shader Cache, Clear Cache, and Cache Status actions.
Tests
Run the Julia test suite. Press Enter or t to start.
# Global Keybindings
| Key | Action |
|---|---|
| q / Ctrl-C | Quit |
| ? | Toggle help overlay |
| 1-5 | Switch to tab |
| Tab / Shift-Tab | Next / previous tab |
| Esc | Close overlay |
| g / G | Scroll log to top / bottom |
| PgUp / PgDn | Scroll log by page |
# Troubleshooting
Julia not found
Ensure Julia 1.9+ is installed and on your PATH. Verify with julia --version.
Engine path does not exist
Check that .openreality/config.toml has the correct engine_path.
WASM build failures
Ensure wasm-pack is installed: cargo install wasm-pack.
Shader cache issues
Clear the cache and rebuild: orcli cache clear && orcli cache shaders.