Boost Your Python CLI Productivity with Argcomplete Auto‑Completion

1. Overview

When using the python command or its command‑line tools, a common pain point is the lack of tab‑completion. For example, after python -m there is no suggestion for package names, and tools like pip or pipx also lack completion.

We discovered the argcomplete library, which adds tab‑completion to Python commands with a simple Tab press, making the CLI experience much smoother.

Key features of argcomplete include:

Official support for bash and zsh; third‑party support for tcsh and fish.

Completion for both python and pip commands.

Automatic completion for any third‑party tool that uses argparse – just add a few lines of code.

2. Enable Auto‑Completion for Python and pip

First install argcomplete via pip: pip install argcomplete Then run the following command to activate global completion for Python and pip: activate-global-python-argcomplete Restart your shell and try typing pip followed by Tab; the available options should appear.

3. Enable Completion for Other Third‑Party Tools

Some command‑line programs already support argcomplete. Activate them with:

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

For example, after installing pipx, run: eval "$(register-python-argcomplete pipx)" Now typing pipx in and pressing Tab will list commands starting with in, and further Tab presses will cycle through the candidates.

Note: This activation only works for programs that already contain the necessary argcomplete hooks.

4. Make Your Own Python Package Support Auto‑Completion

Add the following lines before creating the ArgumentParser object in your package:

# Before initializing ArgumentParser
PYTHON_ARGCOMPLETE_OK
import argcomplete, argparse

# Existing code
parser = argparse.ArgumentParser()
...  # define arguments

# Before calling parse_args()
argcomplete.autocomplete(parser)

# Existing code
args = parser.parse_args()
...

After installing your package, you can enable completion with:

eval "$(register-python-argcomplete <your-package-name>)"

Warning: If argcomplete.autocomplete() is called before time‑consuming imports, the tab‑completion may feel sluggish. Place heavy imports after the autocomplete call to keep the response fast.

Hopefully this guide makes your Python development experience more comfortable.