Shell completion
TmuxWorkspace 0.1.0-alpha.5 · 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
ArgumentParser defines the native command graph and supplies
--generate-completion-script for shell completion. Manual, DocC, and site
metadata integration remain separate work. Use supported parser APIs for those
exports; private parser reflection is not a stable contract.
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.