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.
The user guide is published at https://not-elm.github.io/orzma/ with each
release. Its sources are in docs/book/src.
- Getting Started — install orzma.
- Configuration and Key Bindings.
- Building Webview Apps and the Webview Protocol.
macOS 11 or later on Apple Silicon, with Homebrew:
brew install --cask not-elm/orzma/orzmaWindows 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 Getting Started for details.
| Name | Description |
|---|---|
| orzmd | A rich Markdown viewer |
| orzbrowser | A keyboard-driven browser |
- 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.orzmabridge.
See Building Webview Apps for a tutorial.
See CONTRIBUTING.md.
MIT. See LICENSE.