1. Homepage
  2. Exchange
  3. API カタログ CLI を使用した API の自動カタログ化

  4. コマンドのオートコンプリートの設定

コマンドオートコンプリートを設定する

api-catalog-cli autocomplete​ コマンドでは、API カタログ CLI コマンドのコンプリートを設定できます。

コマンドオートコンプリートを設定する手順は、次のとおりです。

  • Bash シェルを使用している場合:

    1. api-catalog autocomplete bash​ を実行します。これにより、キャッシュが作成されて、設定とテスト手順が表示されます。

    2. コマンドで表示される手順に従います。

      1) Add the autocomplete env var to your bash profile and source it
$ printf "eval $(api-catalog autocomplete:script bash)" >> ~/.bashrc; source ~/.bashrc

NOTE: If your terminal starts as a login shell you may need to print the init script into ~/.bash_profile or ~/.profile.

2) Test it out, e.g.:
$ api-catalog <TAB><TAB>                 # Command completion
$ api-catalog [command] --<TAB><TAB>       # Flag completion

  • Z シェルを使用している場合:

    1. api-catalog autocomplete zsh​ を実行します。これにより、キャッシュが作成されて、設定とテスト手順が表示されます。

    2. コマンドで表示される手順に従います。

      1) Add the autocomplete env var to your zsh profile and source it
$ printf "eval $(api-catalog autocomplete:script zsh)" >> ~/.zshrc; source ~/.zshrc

NOTE: After sourcing, you can run `$ compaudit -D` to ensure that no permissions conflicts are present

2) Test it out, e.g.:
$ api-catalog <TAB>                 # Command completion
$ api-catalog [command] --<TAB>       # Flag completion

api-catalog autocomplete

$ api-catalog autocomplete [flags]

このコマンドは、次のフラグを受け入れます。

フラグ 説明

blank

オートコンプリートの設定手順を表示します。

bash

Bash シェル設定を使用してオートコンプリートをインストールします。

zsh

Z シェル設定を使用してオートコンプリートをインストールします。

-r, --refresh cache

現在のオートコンプリート設定を削除します。これは、別のシェル種別でコマンドを実行する前に使用します。

例​

$ api-catalog autocomplete
$ api-catalog autocomplete bash
$ api-catalog autocomplete zsh
$ api-catalog autocomplete --refresh-cache
現時点では、API Catalog CLI オートコンプリートプラグインは、Windows ではサポートされていません。