Skip to content
Apothem
Справочник CLI

completion

Справочник CLI для команды apothem completion.

Печатает в стандартный вывод скрипт автодополнения оболочки для запрошенного shell. Включение автодополнения — по выбору пользователя: эта команда лишь печатает скрипт — она никогда не редактирует ваши файлы запуска оболочки. Вы сами добавляете вывод в файл автодополнения оболочки.

Сводка

apothem completion bash|zsh|fish|powershell

Выпущенный скрипт включает автодополнение по <TAB> для подкоманд и флагов apothem, а — для опции --harness — для зарегистрированных id harness плюс all.

Поддерживаемые shell

ShellКак создаётся скрипт
bashНативный скрипт автодополнения bash от Click.
zshНативный скрипт автодополнения zsh от Click.
fishНативный скрипт автодополнения fish от Click.
powershellФрагмент Register-ArgumentCompleter, который связывается с протоколом автодополнения Click (Click не поставляет нативный скрипт PowerShell, поэтому этот фрагмент подключает тот же протокол к PowerShell).

Запрос любого другого shell завершается с кодом 2 вместе со списком поддерживаемых shell.

Включение автодополнения по shell

Сначала команда apothem должна находиться в вашем PATH (однократные установщики помещают её туда). Затем включите автодополнение, добавив скрипт в файл автодополнения оболочки и перезапустив оболочку:

# bash — добавить в ваш bashrc
apothem completion bash >> ~/.bashrc

# zsh — добавить в ваш zshrc
apothem completion zsh >> ~/.zshrc

# fish — записать в каталог автодополнений fish
apothem completion fish > ~/.config/fish/completions/apothem.fish
# PowerShell — добавить регистрацию дополнителя в ваш профиль
apothem completion powershell >> $PROFILE

Чтобы попробовать автодополнение только для текущего сеанса, не редактируя ни одного файла, выполните source скрипта напрямую (bash/zsh): source <(apothem completion bash).

Почему это по выбору

Apothem никогда не редактирует тихо файлы запуска оболочки оператора. Установщики печатают однострочную подсказку, указывающую на эту команду; оператор решает, включать ли автодополнение и к какому файлу его добавить. Это сохраняет след установки предсказуемым и обратимым — удаление добавленного блока отключает автодополнение.

Опции

ОпцияОписание
SHELLОдна из bash, zsh, fish, powershell (обязательный позиционный аргумент).
-h, --helpПоказать справку и выйти.

Коды выхода

КодЗначение
0Скрипт автодополнения выпущен
2Запрошен неподдерживаемый shell

См. также

On this page