register-python-argcomplete1

Overview

usage: register-python-argcomplete [-h] [--no-defaults]

[--complete-arguments ...]: [-s {bash,zsh,tcsh,fish,powershell}] [-e EXTERNAL_ARGCOMPLETE_SCRIPT] executable [executable ...]

To perform the registration, source the output of this script in your bash shell (quote the output to avoid interpolation).

Example:

: $ eval "$(register-python-argcomplete my-favorite-script.py)"

For Tcsh

: $ eval `register-python-argcomplete --shell tcsh my-favorite-script.py`

For Fish

: $ register-python-argcomplete --shell fish my-favourite-script.py > ~/.config/fish/my-favourite-script.py.fish

positional arguments:

executable: executable to completed (when invoked by exactly this name)

options:

-h, --help: show this help message and exit

--no-defaults: when no matches are generated, do not fallback to readline's default completion (affects bash only)

--complete-arguments ...: arguments to call complete with; use of this option discards default options (affects bash only)

-s {bash,zsh,tcsh,fish,powershell}, --shell {bash,zsh,tcsh,fish,powershell}: output code for the specified shell

-e EXTERNAL_ARGCOMPLETE_SCRIPT, --external-argcomplete-script EXTERNAL_ARGCOMPLETE_SCRIPT: external argcomplete script for auto completion of the executable

Releases

6 releases since Debian 8 (Jessie); the text changed 2 times.

--complete-arguments since Debian 9 (Stretch); --external-argcomplete-script since Debian 13 (Trixie); --no-defaults since Debian 9 (Stretch); --shell since Debian 9 (Stretch); -e since Debian 13 (Trixie); -s since Debian 9 (Stretch).