Companion Apps

orzma comes with two terminal apps that show web pages inside the terminal, built with the ratatui_orzma SDK: orzmd, a Markdown viewer, and orzbrowser, a keyboard-driven browser. Homebrew links both into your PATH, and the Windows installer and the Linux .deb add them to it; the Linux tarball keeps them in ~/.local/share/orzma (see Getting Started). To build them from a clone of the repository instead, run just install-apps.

Both run only inside an orzma pane. Anywhere else, they exit with an error such as:

orzmd: not inside an orzma pane: ORZMA_SOCK is unset. Run orzmd inside an orzma pane.

orzmd

orzmd runs inside an orzma pane and renders Markdown in an embedded webview, wrapped in native terminal chrome: a status line, an optional outline panel, and a search line. You drive it from the keyboard like a pager, while the page handles rich rendering — diagrams, math, and highlighted code.

Features

• Live reload — saving the file re-renders it automatically, and your scroll position is preserved across reloads.
• Syntax highlighting — fenced code blocks are highlighted with highlight.js.
• Math — LaTeX rendered with KaTeX ($inline$ and $$block$$).
• Mermaid diagrams — ```mermaid fences render as diagrams.
• GitHub alerts — > [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], and [!CAUTION] blockquotes render as colored callout boxes with icons.
• Outline panel — jump between the document’s headings.
• In-page search — highlight matches and step through them.

Usage

orzmd <markdown-file>

The status line at the top shows the file name, the live-reload state, and the scroll position:

orzmd · README.md    ● live    42%

● live means the file is being watched. If the file is deleted, the status switches to ○ missing and the last rendered content stays on screen.

On Windows, local images referenced by a document are staged as symlinks when Windows allows it (Developer Mode is on, or orzmd runs as administrator) and copied otherwise; a copied image does not refresh until orzmd is restarted.

Keyboard shortcuts

Reading

While the page has keyboard focus, Ctrl-c copies in the page instead of quitting; q still quits, because orzmd forwards it to the TUI even while the page is focused.

Outline panel

Search

After running a search, use n / N in reading mode to move between matches, and Esc to clear the highlight.

orzbrowser

orzbrowser runs inside an orzma pane and loads a remote URL in an embedded webview, wrapped in native terminal chrome: a status line, an address bar, and a help modal. You drive it from the keyboard like a Vim-style pager — scrolling, following links by typing hint labels, and stepping through history — while the page renders in the webview.

Features

• Vim-style scrolling — j / k move by line, Ctrl-d / Ctrl-u by half a page, Ctrl-f / Ctrl-b by a full page, and gg / G jump to the top / bottom.
• Link hints — press f to overlay labels on every link and form field, then type a label to follow it. Landing on a text field switches to Insert mode automatically.
• History — H and L step back and forward through the session history.
• Address bar — o (or :) opens the address bar pre-filled with the current URL; a scheme-less entry like github.com is completed to https://.
• Modal input — Normal, Insert, Address, Hint, and Help modes. i hands keyboard focus to the page so you can type into it; Esc returns to Normal.
• In-app help — ? shows the full shortcut list.

Usage

orzbrowser <url>

The status line at the top shows the current mode and the loaded URL:

[Normal] https://example.com

Opening the address bar with o or : replaces it with an editable prompt:

> https://example.com_

Keyboard shortcuts

Normal

While the page has keyboard focus, Ctrl-c copies in the page instead of quitting; q still quits, since Normal mode forwards it to the TUI even while the page is focused.

Address bar

Hint

Insert

In Insert mode every other key goes to the page, so you can type into focused inputs.

Help

Acknowledgements

orzbrowser’s keyboard model and link-hint workflow are inspired by Vimium, the keyboard-driven browser extension. The hint alphabet (sadfjklewcmpgh) is Vimium’s default. Vimium is distributed under the MIT License; orzbrowser ships an independent implementation rather than Vimium source.