Using argcomplete to Add Auto-Completion for Python and pip Commands

Overview: The article introduces the lack of tab completion for Python and pip commands and presents argcomplete as a solution.

Features of argcomplete: supports bash and zsh, third‑party support for tcsh and fish, can complete python and pip commands, and any argparse‑based CLI.

Enabling auto‑completion for Python and pip:

<code>pip install argcomplete</code>

Then run:

<code>activate-global-python-argcomplete</code>

Restart the shell and tab‑complete pip commands.

Enabling completion for other third‑party tools:

<code>eval "$(register-python-argcomplete <python-app-name>)"</code>

Example for pipx:

<code>eval "$(register-python-argcomplete pipx)"</code>

Adding argcomplete support to your own Python package requires adding the marker # PYTHON_ARGCOMPLETE_OK before creating the ArgumentParser, importing argcomplete, and calling argcomplete.autocomplete(parser) before parsing arguments.

After installation, the command can be completed with eval "$(register-python-argcomplete <your‑package>)" . Note that heavy operations before argcomplete.autocomplete() may cause noticeable delay.

Reference: argcomplete GitHub repository.