Workspace ManagerconceptInternals

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Edit this page on GitHub

Workspace reference generation

@libtmux/workspace 0.1.0-alpha.12 · Source

The executable’s parser owns its command names, arguments and options. Keep reference generation tied to those definitions.

Command metadata

Commander owns the command definitions. The package generates Markdown, a JSON command catalog and completion scripts from those definitions. docs:check checks their freshness.

See shell completion for end-user setup. A generated parser reference describes syntax; task examples also need to exercise the underlying services and their cleanup.

Site integration

Record the CLI’s own source revision independently from the core library reference. Keep commands, configuration and examples specific to that source. Use the same content selection for HTML, search, Markdown and machine exports.

Verify guides against a private tmux server, with cleanup limited to the objects the test owns. Check failure cases as well as successful construction.

CLI source.

Esc

Type to search.

Reference previewOpen reference