Completions

Shell completions let your shell suggest vcspull’s subcommands and flags as you type — press tab and the rest is filled in. vcspull 1.15+ generates the completion scripts with shtab; support is provisional, and shtab is installed separately.

vcspull 1.15+ (experimental)

Note

See the shtab library’s documentation on shell completion for the most up to date way of connecting completion for vcspull.

Install shtab first — it is not bundled with vcspull:

$ pip install shtab --user

Or using uv:

$ uv tool install shtab

For one-time use without installation:

$ uvx shtab

Then generate and install the completion script for your shell:

bash

$ shtab \
    --shell=bash \
    --error-unimportable \
    vcspull.cli.create_parser \
    | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/VCSPULL

zsh

$ shtab \
    --shell=zsh \
    --error-unimportable \
    vcspull.cli.create_parser \
    | sudo tee /usr/local/share/zsh/site-functions/_VCSPULL

tcsh

$ shtab \
    --shell=tcsh \
    --error-unimportable \
    vcspull.cli.create_parser \
    | sudo tee /etc/profile.d/VCSPULL.completion.csh

vcspull 0.9 to 1.14

Note

See the click library’s documentation on shell completion for the most up to date way of connecting completion for vcspull.

vcspull 0.9 to 1.14 use click’s completion:

bash

~/.bashrc:

$ printf '%s\n' 'eval "$(_VCSPULL_COMPLETE=bash_source vcspull)"' >> ~/.bashrc

zsh

~/.zshrc:

$ printf '%s\n' 'eval "$(_VCSPULL_COMPLETE=zsh_source vcspull)"' >> ~/.zshrc