completion
Referencia de la CLI para el comando apothem completion.
Imprime en stdout un script de autocompletado para la shell solicitada. Habilitar el autocompletado es opcional: este comando solo imprime el script — nunca edita los archivos de inicio de tu shell. Tú mismo agregas la salida al archivo de autocompletado de la shell.
Sinopsis
apothem completion bash|zsh|fish|powershellEl script emitido habilita el autocompletado con <TAB> de los subcomandos y
los indicadores de apothem y — para la opción --harness — de los ids de
entorno registrados, además de all.
Shells admitidas
| Shell | Cómo se produce el script |
|---|---|
bash | El script nativo de autocompletado de bash de Click. |
zsh | El script nativo de autocompletado de zsh de Click. |
fish | El script nativo de autocompletado de fish de Click. |
powershell | Un script Register-ArgumentCompleter generado por la clase de autocompletado de PowerShell que Apothem registra en Click (Click no incluye ninguna de forma nativa), que impulsa el mismo protocolo de autocompletado que las demás shells. |
Solicitar cualquier otra shell sale con 64 y la lista de shells admitidas.
Habilitar el autocompletado por shell
El comando apothem debe estar primero en tu PATH. Los instaladores de un
solo paso escriben un shim apothem en $HOME/.local/bin (POSIX) o en
%LOCALAPPDATA%\Microsoft\WindowsApps (Windows) y nunca editan tu PATH, así
que agrega ese directorio si todavía no figura en la lista. Luego habilita el
autocompletado agregando el script al archivo de autocompletado de la shell y
reiniciando la 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 >> $PROFILEPara probar el autocompletado solo en la sesión actual sin editar ningún
archivo, carga el script directamente con source (bash/zsh):
source <(apothem completion bash).
Por qué es opcional
Apothem nunca edita en silencio los archivos de inicio de la shell de un operador. Los instaladores imprimen una indicación de una línea que apunta a este comando; el operador decide si habilita el autocompletado y a qué archivo lo agrega. Esto mantiene la huella de la instalación predecible y reversible: eliminar el bloque agregado deshabilita el autocompletado.
Opciones
| Opción | Descripción |
|---|---|
SHELL | Una de bash, zsh, fish, powershell (argumento posicional obligatorio). |
-h, --help | Muestra la ayuda y sale. |
Códigos de salida
| Código | Significado |
|---|---|
| 0 | Script de autocompletado emitido |
| 64 | Se solicitó una shell no admitida, u otro error de uso, como una opción desconocida. completion no tiene modo --json: imprime un script, y pasar --json es en sí mismo un error de uso. |
Véase también
- apothem install — instala la configuración de un entorno
- apothem harnesses — los ids de entorno que ofrece el autocompletado de
--harness - Referencia de la CLI — todos los subcomandos