Shell completion
libtmux-workspace 0.0.1-alpha.12-SNAPSHOT · 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
Picocli defines the native command graph. --generate schema exports metadata
and --generate bash emits completion through its code generator. Other manual
and completion formats are not exposed by the workspace executable.
Normal Bash generation writes the script directly. Add --json for a versioned
artifact with "command": "generate", "format": "bash", the exact text in
"script", and "status": "ok". --ndjson emits that artifact as one
completed event with "sequence": 1 and takes precedence over --json.
Schema generation retains its metadata document in every output mode. See the
native generation 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.