xontrib-argcomplete

Argcomplete support for python and xonsh scripts in xonsh shell.

If you like the idea click ⭐ on the repo and and tweet.

[Demo]
^{Screenshot made with xontrib-prompt-bar and Konsole.}

Install

xpip install xontrib-argcomplete
echo 'xontrib load argcomplete' >> ~/.xonshrc
# Reload xonsh

Usage

First of all you need to add the argcomplete support to your script:

The PYTHON_ARGCOMPLETE_OK marker should be found in the first 10 lines of the file (example).
Additional .completer was set for add_argument (example).
argcomplete.autocomplete(parser) added before parser.parse_args() (example).

Example for proto.py sample:

xpip install xontrib-argcomplete
xontrib load argcomplete

cd /tmp && git clone https://github.com/anki-code/xontrib-argcomplete
cd xontrib-argcomplete/tests

python proto.py <Tab>  # Suggestions: --help --proto -h
./proto.py --proto tt<Tab>  # Suggestions: http https
./proto.xsh --proto tt<Tab>  # Suggestions: http https
./proto --proto tt<Tab>  # Suggestions: http https

$PATH.append($PWD)
proto --proto tt<Tab>  # Suggestions: http https

The argcomplete xonsh completer will be activated with this cases:

python script.py <Tab>
./script.py <Tab>
./path/script.py <Tab>

xonsh script.xsh <Tab>
./script.xsh <Tab>
./path/script.xsh <Tab>

# scripts without extension should have "env python" or "env xonsh" or path to python/xonsh in the shebang
./script <Tab>
script <Tab>    # script should be found in $PATH

Known issues

Windows is not supported. PRs are welcome!

Development

To switch on the debug mode run $XONTRIB_ARGCOMPLETE_DEBUG = True.
Argcomplete environment variables
Argcomplete documentation

Metadata

Release files for xontrib-argcomplete 0.3.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xontrib-argcomplete 0.3.5
File	Size	Uploaded
xontrib_argcomplete-0.3.5.tar.gz	6.1 kB	Apr 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for xontrib-argcomplete 0.3.5
File	Interpreter	ABI	Platform	Reset
xontrib_argcomplete-0.3.5-py3-none-any.whl 5.5 kB Apr 23, 2026	Python 3	none	any	Details

Total release size: 11.6 kB

Release files / xontrib_argcomplete-0.3.5.tar.gz

Download URL	xontrib_argcomplete-0.3.5.tar.gz
Size	6.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`04d0d51776064b259665853b71a6dd5f5b2a94c47641aee193f00c18db0a1bc2`
BLAKE2b-256 checksum How to use checksums	`a2171e34476c1ca8e61460dab44a396476b06f07f56b53d047d4507e7c980e8f`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.14.4`

Release files / xontrib_argcomplete-0.3.5-py3-none-any.whl

Download URL	xontrib_argcomplete-0.3.5-py3-none-any.whl
Size	5.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d88b1f73061ab69c8d4b998967986e1d6939a4280188b580386100d7f59c941a`
BLAKE2b-256 checksum How to use checksums	`3c405dac86edee7460e6bf4915b00688fd2f28f6be91e062a47f3a011f507500`
Upload date	Apr 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.14.4`