CLI 参考
completion
apothem completion 命令的 CLI 参考。
将所请求 shell 的补全脚本打印到 stdout。启用补全是需主动选择的：此命令只打印脚本——它绝不会编辑你的 shell 启动文件。你需要自己将输出追加到该 shell 的补全文件中。
概要
apothem completion bash|zsh|fish|powershell输出的脚本会为 apothem 的子命令、标志，以及——对于 --harness 选项——已注册的工具 ID 外加 all 启用 <TAB> 补全。
受支持的 shell
| Shell | 脚本的生成方式 |
|---|---|
bash | Click 原生的 bash 补全脚本。 |
zsh | Click 原生的 zsh 补全脚本。 |
fish | Click 原生的 fish 补全脚本。 |
powershell | 一个 Register-ArgumentCompleter 脚本，由 Apothem 向 Click 注册的 PowerShell 补全类生成（Click 本身不附带任何 PowerShell 补全），它驱动与其他 shell 相同的补全协议。 |
请求任何其他 shell 都会以 64 退出，并给出受支持的 shell 列表。
按 shell 启用补全
首先，apothem 命令必须位于你的 PATH 上。一键安装器会将一个 apothem 垫片写入 $HOME/.local/bin（POSIX）或 %LOCALAPPDATA%\Microsoft\WindowsApps（Windows），并且从不编辑你的 PATH，因此如果该目录尚未列出，请自行添加。然后，将脚本追加到该 shell 的补全文件并重启 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 >> $PROFILE若只想在当前会话中试用补全而不编辑任何文件，可直接 source 该脚本（bash/zsh）：source <(apothem completion bash)。
为何需要主动选择
Apothem 绝不会无声地编辑操作者的 shell 启动文件。安装器会打印一行指向此命令的提示；由操作者决定是否启用补全以及追加到哪个文件。这使安装足迹保持可预测且可逆——移除追加的代码块即可禁用补全。
选项
| 选项 | 描述 |
|---|---|
SHELL | bash、zsh、fish、powershell 之一（必需的位置参数）。 |
-h, --help | 显示帮助并退出。 |
退出码
| 代码 | 含义 |
|---|---|
| 0 | 已输出补全脚本 |
| 64 | 请求了不受支持的 shell，或发生了其他用法错误，例如未知的选项。completion 没有 --json 模式：它打印一个脚本，而传入 --json 本身就是一个用法错误。 |
另请参阅
- apothem install——安装一个工具配置
- apothem harnesses——
--harness补全所提供的工具 ID - CLI 参考——所有子命令