completion
Справочник CLI для команды apothem completion.
Печатает в stdout скрипт автодополнения для запрошенной оболочки. Включение автодополнения выполняется по явному выбору: эта команда только печатает скрипт — она никогда не редактирует файлы запуска вашей оболочки. Вы сами добавляете вывод в файл автодополнения оболочки.
Синтаксис
apothem completion bash|zsh|fish|powershellВыводимый скрипт включает автодополнение по <TAB> для подкоманд и флагов
apothem, а для параметра --harness — для идентификаторов зарегистрированных
окружений плюс all.
Поддерживаемые оболочки
| Оболочка | Как создаётся скрипт |
|---|---|
bash | Нативный скрипт автодополнения bash из Click. |
zsh | Нативный скрипт автодополнения zsh из Click. |
fish | Нативный скрипт автодополнения fish из Click. |
powershell | Скрипт Register-ArgumentCompleter, сгенерированный классом автодополнения PowerShell, который Apothem регистрирует в Click (сам Click нативно не поставляет такого класса); скрипт работает по тому же протоколу автодополнения, что и другие оболочки. |
Запрос любой другой оболочки завершается с кодом 64 и списком поддерживаемых
оболочек.
Включение автодополнения для каждой оболочки
Сначала команда apothem должна находиться в вашем PATH. Одношаговые
установщики записывают шим apothem в $HOME/.local/bin (POSIX) или
%LOCALAPPDATA%\Microsoft\WindowsApps (Windows) и никогда не редактируют ваш
PATH, поэтому добавьте этот каталог, если его там ещё нет. Затем включите
автодополнение, добавив скрипт в файл автодополнения оболочки и перезапустив
оболочку:
# 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 >> $PROFILEЧтобы попробовать автодополнение только для текущего сеанса, не редактируя ни
одного файла, подключите скрипт напрямую через source (bash/zsh):
source <(apothem completion bash).
Почему это делается по явному выбору
Apothem никогда молча не редактирует файлы запуска оболочки оператора. Установщики печатают однострочную подсказку, указывающую на эту команду; оператор сам решает, включать ли автодополнение и в какой файл добавить скрипт. Благодаря этому след установки остаётся предсказуемым и обратимым — удаление добавленного блока отключает автодополнение.
Параметры
| Параметр | Описание |
|---|---|
SHELL | Одно из значений bash, zsh, fish, powershell (обязательный позиционный аргумент). |
-h, --help | Показать справку и завершить работу. |
Коды выхода
| Код | Значение |
|---|---|
| 0 | Скрипт автодополнения выведен |
| 64 | Запрошена неподдерживаемая оболочка или произошла другая ошибка использования, например неизвестный параметр. У completion нет режима --json: команда печатает скрипт, и передача --json сама по себе является ошибкой использования. |
См. также
- apothem install — установить конфигурацию окружения
- apothem harnesses — идентификаторы окружений, которые предлагает автодополнение
--harness - Справочник CLI — все подкоманды