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 |
См. также
- apothem install — устанавливает конфигурацию harness
- apothem harnesses — id harness, которые предлагает автодополнение
--harness - Справочник CLI — все подкоманды