Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Shell completion

TypeScript

Edit this page on GitHub

@libtmux/workspace 0.1.0-alpha.10 · Source

tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.

tmuxp uses the separately installed shtab package for experimental completion. The parser entry point is tmuxp.cli.create_parser. Generate a script in an environment that can import both packages, then use the shell-specific installation procedure from the upstream completion guide.

Native completionLink to section

Commander defines the native command graph. The CLI package generates Markdown, a JSON command catalog, and Bash, Zsh, and Fish completion from those definitions. docs:check compares generated files in CI. Keep option event order when paired flags share a destination.

Completion is derived from actual command metadata. It must include nested import commands, local short flags, positional arity, mutually exclusive choices, and all-command machine options. Verify generated scripts with the installed executable and target shell.

See the command tree and compatibility reference.

tmuxp reference source.

Esc

Type to search.