workspace consumer 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
The local C++ CLI generates Bash, Zsh and Fish completion. Build it through
installation and make the resulting
tmux-workspace executable available on PATH.
Enable Bash completion in the current shell:
$ source <(tmux-workspace --generate-completion bash)For Zsh, initialise its completion system and load the generated script:
$ autoload -Uz compinit && compinit && source <(tmux-workspace --generate-completion zsh)For Fish:
$ tmux-workspace --generate-completion fish | sourceCompletion includes nested import commands, command-specific flags, enumerated values and file paths, including names containing spaces. It does not start tmux or read workspace files. Dynamic session names and configuration aliases are not suggested. Add the matching setup command to your shell configuration to enable completion in later sessions.
This is part of the unreleased native CLI. The documentation exporter remains separate from shell completion.
See the command tree and compatibility reference.