completion
CLI-Referenz für den Befehl apothem completion.
Gibt ein Shell-Vervollständigungsskript für die angeforderte Shell nach stdout aus. Das Aktivieren der Vervollständigung ist optional: Dieser Befehl gibt nur das Skript aus — er bearbeitet niemals Ihre Shell-Startdateien. Sie hängen die Ausgabe selbst an die Vervollständigungsdatei der Shell an.
Übersicht
apothem completion bash|zsh|fish|powershellDas ausgegebene Skript aktiviert die <TAB>-Vervollständigung von
apothem-Unterbefehlen, Flags und — für die Option --harness — den
registrierten Harness-IDs sowie all.
Unterstützte Shells
| Shell | Wie das Skript erzeugt wird |
|---|---|
bash | Das native bash-Vervollständigungsskript von Click. |
zsh | Das native zsh-Vervollständigungsskript von Click. |
fish | Das native fish-Vervollständigungsskript von Click. |
powershell | Ein Register-ArgumentCompleter-Skript, das von der PowerShell-Vervollständigungsklasse erzeugt wird, die Apothem bei Click registriert (Click liefert nativ keine mit), und das dasselbe Vervollständigungsprotokoll ansteuert wie die anderen Shells. |
Das Anfordern jeder anderen Shell endet mit Exit-Code 64 und der Liste der
unterstützten Shells.
Vervollständigung je Shell aktivieren
Der Befehl apothem muss zuerst in Ihrem PATH liegen. Die Ein-Schritt-Installer
schreiben einen apothem-Shim nach $HOME/.local/bin (POSIX) oder
%LOCALAPPDATA%\Microsoft\WindowsApps (Windows) und bearbeiten Ihren PATH
niemals; fügen Sie dieses Verzeichnis daher hinzu, falls es noch nicht
aufgeführt ist. Aktivieren Sie die Vervollständigung dann, indem Sie das Skript
an die Vervollständigungsdatei der Shell anhängen und die Shell neu starten:
# 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 >> $PROFILEUm die Vervollständigung nur für die aktuelle Sitzung auszuprobieren, ohne eine
Datei zu bearbeiten, laden Sie das Skript direkt per source (bash/zsh):
source <(apothem completion bash).
Warum es optional ist
Apothem bearbeitet niemals still die Shell-Startdateien eines Operators. Die Installer geben einen einzeiligen Hinweis aus, der auf diesen Befehl verweist; der Operator entscheidet, ob er die Vervollständigung aktiviert und an welche Datei er das Skript anhängt. Das hält den Installations-Fußabdruck vorhersehbar und umkehrbar — das Entfernen des angehängten Blocks deaktiviert die Vervollständigung.
Optionen
| Option | Beschreibung |
|---|---|
SHELL | Eine von bash, zsh, fish, powershell (erforderliches Positionsargument). |
-h, --help | Zeigt die Hilfe an und beendet den Befehl. |
Exit-Codes
| Code | Bedeutung |
|---|---|
| 0 | Vervollständigungsskript ausgegeben |
| 64 | Nicht unterstützte Shell angefordert oder ein anderer Verwendungsfehler, etwa eine unbekannte Option. completion hat keinen --json-Modus: Der Befehl gibt ein Skript aus, und die Angabe von --json ist selbst ein Verwendungsfehler. |
Siehe auch
- apothem install — installiert eine Harness-Konfiguration
- apothem harnesses — die Harness-IDs, die die
--harness-Vervollständigung anbietet - CLI-Referenz — alle Unterbefehle