orzma

[!WARNING] orzma is in early development and may introduce breaking changes.

orzma is a terminal emulator that can render web pages inside the terminal. A program running in an orzma pane can place a live web page among its own text and exchange messages with it.

https://github.com/user-attachments/assets/da9d061f-4d25-431d-964d-d0700332c5d6

Companion apps

The webview protocol extends what a terminal program can do. Every install includes two apps built on it, orzmd (left) and orzbrowser (right), and each runs inside an orzma pane.

To build your own, see SDK.

Documentation

The user guide is published at https://not-elm.github.io/orzma/ with each release. Its sources are in docs/book/src.

• Installation — install orzma.
• Configuration, Key Bindings, and Default Key Bindings.
• Building Webview Apps and the Webview Protocol.

Installation

macOS 11 or later on Apple Silicon, with Homebrew:

brew install --cask not-elm/orzma/orzma

Or download orzma-<version>-arm64.dmg from the latest release, open it, and drag orzma.app into Applications. orzma is not notarized, so see First launch before opening it.

Windows 10 1809 or later, and Windows 11 (x64): download orzma-<version>-x64.msi from the latest release and run it.

Linux (x86_64) with glibc 2.35 or later: download the .deb for Ubuntu or Debian, or the tarball for other distributions, from the latest release.

See Installation for details.

SDK

• ratatui_orzma — Rust SDK: a ratatui widget and RPC handler for embedding orzma webviews in a TUI app.
• @orzma/web — TypeScript client for the in-page window.orzma bridge.

See Building Webview Apps for a tutorial.

Contributing

See CONTRIBUTING.md.

License

MIT. See LICENSE.