Shell 補完とヘルプを有効にする

Helmには組み込みのシェル補完と充実したヘルプシステムがあります。これらを使えば、何も暗記せずにコマンドやフラグを調べられます。

helm completion コマンドは、使用するシェル向けのスクリプトを生成します。bash、zsh、fish、PowerShellを標準でサポートしています。

bashでは、生成したスクリプトを .bashrc でsourceします。そうすれば、シェルを開くたびに補完が読み込まれます。

zshユーザーも zsh サブコマンドで同じことを行います。.zshrcに追加するか、起動を速くするためにfpath上のディレクトリに書き込みます。

Helmの補完は賢く動作します。helm upgrade の後にTabを押すと、静的なコマンド名だけでなく、クラスター上の実際のリリース名も候補に表示されます。

任意のコマンドに --help を追加すると、その目的、フラグ、使用例を確認できます。helmから深い階層のサブコマンドまで、あらゆるレベルで利用できます。

コマンドを指定せずに helm help を実行すると、利用可能なすべてのサブコマンドが一覧表示されます。Helmでできることを忘れたときの案内図になります。

helm help upgrade のように、helpにコマンドを渡すこともできます。これはupgrade --helpと同じ内容を、別の書き方で表示するものです。

各ヘルプページでは、フラグがコマンドフラグとグローバルフラグに分けて表示されます。--namespaceや--kube-contextのようなグローバルフラグは、ほぼすべてのコマンドに適用されます。

ヘルプにはインストール済みのプラグインも表示されます。追加したプラグインは、Helm標準のサブコマンドであるかのようにhelm helpに表示され、簡単に見つけられます。

補完のsourceは現在のシェルでのみ有効です。保持するには、生成したスクリプトをシェルのプロファイルに書き込み、ログインするたびに読み込まれるようにします。

upgradeのフラグを忘れてしまい、すぐに確認したいとします。

シェルで helm completion を有効にすると、Tabキーでコマンドやリリースを補完できます。また、--helpやhelm helpを活用すれば、どのコマンドもすぐに学べます。🚀