(completion)=

(completions)=

(cli-completions)=

See the [shtab library's documentation on shell completion](https://docs.iterative.ai/shtab/use/#cli-usage) for the most up to date way of connecting completion for tmuxp.

Provisional support for completions in tmuxp 1.17+ are powered by shtab. This must be installed separately, as it's not currently bundled with tmuxp.

$ pip install shtab --user

With a uv project you can add it directly as a development dependency:

$ uv add --dev shtab

Or reach for uvx when you want a pipx-style ephemeral install:

$ uvx shtab --help

:::{tab} bash

shtab --shell=bash -u tmuxp.cli.create_parser \
  | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/TMUXP

:::

:::{tab} zsh

shtab --shell=zsh -u tmuxp.cli.create_parser \
  | sudo tee /usr/local/share/zsh/site-functions/_TMUXP

:::

:::{tab} tcsh

shtab --shell=tcsh -u tmuxp.cli.create_parser \
  | sudo tee /etc/profile.d/TMUXP.completion.csh

:::

See the [click library's documentation on shell completion](https://click.palletsprojects.com/en/8.0.x/shell-completion/) for the most up to date way of connecting completion for tmuxp.

tmuxp 1.1 to 1.16 use click's completion:

:::{tab} Bash

~/.bashrc:

eval "$(_TMUXP_COMPLETE=bash_source tmuxp)"

:::

:::{tab} Zsh

~/.zshrc:

eval "$(_TMUXP_COMPLETE=zsh_source tmuxp)"

:::