pycompgen 0.3.0

Generate shell completions automatically

pycompgen

Automatically generate shell completions for Python tools installed via uv and pipx.

Currently, bash, zsh, and fish on Linux are supported. Also, only Python tools that use the click or argcomplete libraries are supported, besides some select commands:

• uv
• uvx

Installation

uv tool install pycompgen
# Or if you prefer pipx:
pipx install pycompgen

Usage

Run pycompgen to generate completions for all installed tools:

pycompgen

The tool will:

1. Detect Python packages installed via uv tool and pipx as well as some select commands
2. Analyze which ones support shell completions
3. Generate completion files in ~/.cache/pycompgen/
4. Create a source script to load all completions

Add the source script to your shell config:

# For bash: - add to ~/.bashrc:
source <(pycompgen --source) ; (pycompgen &)

# For zsh: - add to ~/.zshrc:
source <(pycompgen --shell zsh --source) ; (pycompgen --shell zsh &)

# For fish: - add to ~/.config/fish/config.fish:
pycompgen --shell fish &; disown

This will load the generated shell completions and generate new completions for the next time.

The fish shell will automatically read the completions generated by pycompgen in .cache/fish/generated_completions.

Options

• --cache-dir PATH: Override the default cache directory
• --force: Force regeneration of all completions
• --shell: Target shell - bash, zsh, or fish (default: ${PYCOMPGEN_SHELL:-bash})
• --verbose: Enable detailed output
• --source: Only write the source file contents to stdout and exit
• --cooldown-time: Minimum amount of seconds between regenerations

Development

Install development dependencies:

uv sync --group dev
uv run pre-commit install

Run tests:

uv run pytest

Run linting and formatting:

uv run ruff check src tests
uv run ruff format src tests
uv run mypy src

License

MIT