completion
Référence de la CLI pour la commande apothem completion.
Affiche sur stdout un script de complétion shell pour le shell demandé. L'activation de la complétion est à votre initiative : cette commande ne fait qu'afficher le script — elle ne modifie jamais vos fichiers de démarrage du shell. C'est vous qui ajoutez la sortie au fichier de complétion du shell.
Synopsis
apothem completion bash|zsh|fish|powershellLe script émis active la complétion par <TAB> des sous-commandes et des
options d'apothem et — pour l'option --harness — des identifiants
d'environnement enregistrés, plus all.
Shells pris en charge
| Shell | Mode de production du script |
|---|---|
bash | Le script de complétion bash natif de Click. |
zsh | Le script de complétion zsh natif de Click. |
fish | Le script de complétion fish natif de Click. |
powershell | Un script Register-ArgumentCompleter généré par la classe de complétion PowerShell qu'Apothem enregistre auprès de Click (Click n'en fournit aucune nativement), et qui pilote le même protocole de complétion que les autres shells. |
Demander tout autre shell termine la commande avec le code 64 et la liste
des shells pris en charge.
Activer la complétion pour chaque shell
La commande apothem doit d'abord se trouver dans votre PATH. Les
installateurs en une seule étape écrivent un shim apothem dans
$HOME/.local/bin (POSIX) ou %LOCALAPPDATA%\Microsoft\WindowsApps (Windows)
et ne modifient jamais votre PATH ; ajoutez donc ce répertoire s'il n'y figure
pas déjà. Activez ensuite la complétion en ajoutant le script au fichier de
complétion du shell, puis redémarrez le shell :
# bash — append to your bashrc
apothem completion bash >> ~/.bashrc
# zsh — append to your zshrc
apothem completion zsh >> ~/.zshrc
# fish — write to the fish completions directory
apothem completion fish > ~/.config/fish/completions/apothem.fish# PowerShell — append the completer registration to your profile
apothem completion powershell >> $PROFILEPour essayer la complétion uniquement dans la session courante, sans modifier
aucun fichier, chargez directement le script avec source (bash/zsh) :
source <(apothem completion bash).
Pourquoi l'activation est à votre initiative
Apothem ne modifie jamais silencieusement les fichiers de démarrage du shell d'un opérateur. Les installateurs affichent une indication d'une ligne renvoyant vers cette commande ; l'opérateur décide d'activer ou non la complétion et du fichier auquel ajouter le script. L'empreinte de l'installation reste ainsi prévisible et réversible — supprimer le bloc ajouté désactive la complétion.
Options
| Option | Description |
|---|---|
SHELL | L'un de bash, zsh, fish, powershell (argument positionnel obligatoire). |
-h, --help | Affiche l'aide et quitte. |
Codes de sortie
| Code | Signification |
|---|---|
| 0 | Script de complétion émis |
| 64 | Shell non pris en charge demandé, ou autre erreur d'utilisation, comme une option inconnue. completion n'a pas de mode --json : la commande affiche un script, et passer --json constitue en soi une erreur d'utilisation. |
Voir aussi
- apothem install — installe la configuration d'un environnement
- apothem harnesses — les identifiants d'environnement que propose la complétion de
--harness - Référence de la CLI — toutes les sous-commandes