completion
apothem completion コマンドの CLI リファレンス。
要求されたシェル向けのシェル補完スクリプトを stdout に出力します。 補完の有効化はオプトインです。このコマンドはスクリプトを出力するだけで —— シェルの起動ファイルを編集することは決してありません。 出力をシェルの補完ファイルに追加するのは、あなた自身です。
構文
apothem completion bash|zsh|fish|powershell出力されるスクリプトは、apothem のサブコマンド、フラグ、そして —— --harness オプションについては —— 登録されているハーネス ID と all の <TAB> 補完を有効にします。
サポートされているシェル
| シェル | スクリプトの生成方法 |
|---|---|
bash | Click のネイティブな bash 補完スクリプト。 |
zsh | Click のネイティブな zsh 補完スクリプト。 |
fish | Click のネイティブな fish 補完スクリプト。 |
powershell | Apothem が Click に登録する PowerShell 補完クラス（Click はネイティブには何も同梱していません）によって生成される Register-ArgumentCompleter スクリプトで、他のシェルと同じ補完プロトコルを駆動します。 |
その他のシェルを要求すると、サポートされているシェルの一覧とともに 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 が、オペレーターのシェル起動ファイルを黙って編集することは決してありません。 インストーラーは、このコマンドを指し示す 1 行のヒントを出力します。補完を有効にするかどうか、どのファイルに追加するかは、オペレーターが決めます。 これにより、インストールのフットプリントは予測可能で元に戻せるものに保たれます —— 追加したブロックを削除すれば、補完は無効になります。
オプション
| オプション | 説明 |
|---|---|
SHELL | bash、zsh、fish、powershell のいずれか（必須の位置引数）。 |
-h, --help | ヘルプを表示して終了します。 |
終了コード
| コード | 意味 |
|---|---|
| 0 | 補完スクリプトが出力された |
| 64 | サポートされていないシェルが要求された、または不明なオプションなどのその他の使用法エラー。completion には --json モードがありません。スクリプトを出力するため、--json を渡すこと自体が使用法エラーになります。 |
関連項目
- apothem install — ハーネスの設定をインストールする
- apothem harnesses —
--harnessの補完が提示するハーネス ID - CLI リファレンス — すべてのサブコマンド