completion
Referência da CLI para o comando apothem completion.
Imprime em stdout um script de autocompletar de shell para o shell solicitado. Habilitar o autocompletar é opcional: este comando apenas imprime o script — ele nunca edita os arquivos de inicialização do seu shell. Você mesmo anexa a saída ao arquivo de autocompletar do shell.
Sinopse
apothem completion bash|zsh|fish|powershellO script emitido habilita o autocompletar com <TAB> dos subcomandos e
sinalizadores do apothem e — para a opção --harness — dos ids de harness
registrados mais all.
Shells suportados
| Shell | Como o script é produzido |
|---|---|
bash | O script nativo de autocompletar bash do Click. |
zsh | O script nativo de autocompletar zsh do Click. |
fish | O script nativo de autocompletar fish do Click. |
powershell | Um script Register-ArgumentCompleter gerado pela classe de autocompletar do PowerShell que o Apothem registra no Click (o Click não traz nenhuma nativamente), acionando o mesmo protocolo de autocompletar que os outros shells. |
Solicitar qualquer outro shell sai com 64 e a lista de shells suportados.
Habilitar o autocompletar por shell
O comando apothem precisa estar no seu PATH primeiro. Os instaladores de uma
única etapa gravam um shim apothem em $HOME/.local/bin (POSIX) ou
%LOCALAPPDATA%\Microsoft\WindowsApps (Windows) e nunca editam o seu PATH;
por isso, adicione esse diretório se ele ainda não estiver listado. Em seguida,
habilite o autocompletar anexando o script ao arquivo de autocompletar do shell
e reiniciando o 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 experimentar o autocompletar apenas na sessão atual, sem editar nenhum
arquivo, carregue o script diretamente com source (bash/zsh):
source <(apothem completion bash).
Por que é opcional
O Apothem nunca edita silenciosamente os arquivos de inicialização do shell de um operador. Os instaladores imprimem uma dica de uma linha que aponta para este comando; o operador decide se habilita o autocompletar e a qual arquivo anexar o script. Isso mantém a pegada da instalação previsível e reversível — remover o bloco anexado desabilita o autocompletar.
Opções
| Opção | Descrição |
|---|---|
SHELL | Um de bash, zsh, fish, powershell (argumento posicional obrigatório). |
-h, --help | Mostra a ajuda e sai. |
Códigos de saída
| Código | Significado |
|---|---|
| 0 | Script de autocompletar emitido |
| 64 | Shell não suportado solicitado, ou outro erro de uso, como uma opção desconhecida. completion não tem modo --json: ele imprime um script, e passar --json é por si só um erro de uso. |
Veja também
- apothem install — instala uma configuração de harness
- apothem harnesses — os ids de harness que o autocompletar de
--harnessoferece - Referência da CLI — todos os subcomandos