REGISTER-PYTHON-ARGCOMPLETE(1)

📦 version 1.8.1, in ubuntu jammy

💅 REGISTER-PYTHON-ARGCOMPLETE 💅

okay so bestie, welcome to register-python-argcomplete, a lil User Commands situation from the register-python-argcomplete manual — it's the argcomplete utility script and it is literally here to make your tab-completion dreams come true ✨

🎀 NAME 🎀

register-python-argcomplete — the argcomplete utility script 🦋

🌸 DESCRIPTION 🌸

here's the usage, no cap:

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

[--complete-arguments ...] [-s {bash,tcsh}]
       executable

so what does it even do?? it registers a Python executable for use with the argcomplete module 👑

and to actually perform that registration, you source the output of this script in your bash shell — and quote the output to avoid interpolation, okay?? that part matters, don't skip it 🙈

example time, here's the bash vibe:

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

and for Tcsh:

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

✨ positional arguments: ✨

  • executable — the executable that gets completed, but ONLY when it's invoked by exactly this name 👀

💖 optional arguments: 💖

  • -h, --help — shows this help message and dips. iconic behavior fr fr
  • --no-defaults — when no matches get generated, do NOT fall back to readline's default completion. it's giving "I'll handle it myself" 💅
  • --complete-arguments ... — the arguments you want to call complete with. heads up bestie: using this option discards the default options 😭
  • -s {bash,tcsh}, --shell {bash,tcsh} — spits out code for whichever shell you picked 🐚

👑 AUTHORS 👑

the argcomplete module was written by Andrey Kislyuk — legend behavior, we love to see it 🫶

🌈 SEE ALSO 🌈

the full documentation for the argccomplete module is stored at https://argcomplete.readthedocs.org/en/latest/ — go read it, iykyk 📚

and that's the whole page, bestie!! this was register-python-argcomplete version 1.8.1, dated January 2017, and yes it's still serving main character energy 🎀✨ bye ily 💜

📦 where this page comes from