Reference
June 4, 2026 · View on GitHub
The reference section is the canonical source for the Hollow public surface. Everything here mirrors behavior in the runtime; when the docs and the code disagree, the code wins.
Lua API
Split per namespace under reference/lua/.
Start with Overview and conventions.
| Namespace | Doc | What it does |
|---|---|---|
hollow.config | config.md | Read and write configuration |
hollow.term | term.md | Tabs, panes, workspaces, text, process |
hollow.events | events.md | Subscribe to host events |
hollow.keymap | keymap.md | Bind keys to actions or callbacks |
hollow.ui | ui.md | Widgets, top bar, sidebars, overlays |
hollow.ui.workspace | workspace.md | Workspace switcher and discovery |
hollow.theme | theme.md | Theme resolution and palette |
hollow.htp | htp.md | Register custom HTP channels |
hollow.fonts | fonts.md | Font discovery helpers |
hollow.json | json.md | JSON encode / decode |
hollow.workspace | workspace-api.md | Workspace bootstrap specs |
hollow.async | async.md | Coroutines and promises |
hollow.process | process.md | Run child processes |
hollow.fs | fs.md | Filesystem helpers |
hollow.plugins | plugins.md | Plugin loader and sync |
hollow.util | util.md | Path, color, table utilities |
hollow.platform | platform.md | Read-only platform info |
CLI
Two CLI surfaces ship today. See the CLI index.
- Native
hollow cli …— talks to the host's command socket - Python
hollow-cli— OSC-over-tty HTP client
Actions
- Built-in keymap actions — every string action name you
can pass to
hollow.keymap.set(chord, "name", ...)
Source of truth
The LuaLS typings under types/hollow.lua
are the canonical schema for the Lua API; the per-namespace pages
mirror them.