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.

NamespaceDocWhat it does
hollow.configconfig.mdRead and write configuration
hollow.termterm.mdTabs, panes, workspaces, text, process
hollow.eventsevents.mdSubscribe to host events
hollow.keymapkeymap.mdBind keys to actions or callbacks
hollow.uiui.mdWidgets, top bar, sidebars, overlays
hollow.ui.workspaceworkspace.mdWorkspace switcher and discovery
hollow.themetheme.mdTheme resolution and palette
hollow.htphtp.mdRegister custom HTP channels
hollow.fontsfonts.mdFont discovery helpers
hollow.jsonjson.mdJSON encode / decode
hollow.workspaceworkspace-api.mdWorkspace bootstrap specs
hollow.asyncasync.mdCoroutines and promises
hollow.processprocess.mdRun child processes
hollow.fsfs.mdFilesystem helpers
hollow.pluginsplugins.mdPlugin loader and sync
hollow.utilutil.mdPath, color, table utilities
hollow.platformplatform.mdRead-only platform info

CLI

Two CLI surfaces ship today. See the CLI index.

Actions

Source of truth

The LuaLS typings under types/hollow.lua are the canonical schema for the Lua API; the per-namespace pages mirror them.