Reference

Exact, complete descriptions of every command, option, protocol and API. The reference says what each thing is. For how to use it, with steps and examples, see the Guide.

The command-line pages and the socket and plugin protocols are built from the repository's docs/ each time the site is built, so they always match the code on main. The C ABI and Node.js pages are checked against the build's list of public symbols (api/*.txt).

Command line

Page	What it covers
Commands	Every command and option, grouped as sessions, sending keys, reading the screen, waiting and searching, buffers, viewing, environment, server, plugins and diagnostics.
Keys, formats and exit codes	Key names for send-keys, format variables for -F and display-message, and exit codes.
Environment variables	Every variable zeropty reads, with its default.
tmux compatibility	What zeropty does and does not do compared with tmux.

From programs

Page	What it covers
Socket protocol	The JSON lines on the server's socket, and moving sessions between servers.
C ABI	Every function, type and macro of libzeropty_c.dylib and zeropty.h.
Node.js API	Every export of client/zeropty.mjs, client/embedded.mjs and zeropty.node.
Rust API	The Rust crate: the engine in your process, the server-plugin variant, plugins in Rust, and how to build the rustdoc.
Plugin API	Access rules, the plugin socket protocol, events, commands and the Rust API of zeropty::plugin.

Elsewhere

Where	What
Guide	Concepts and task guides.
Benchmarks	Every measurement and how it was taken.
Changelog	Changes, release by release.
llms.txt, llms-full.txt	This site as plain text, for tools.
zeropty --help, zeropty help COMMAND	The same command reference, offline.