Docs Menu
Docs Home
/ /
MongoDB CLI
/

MongoDB CLI のオートコンプリート有効化

項目一覧

  • オートコンプリートを有効にする
  • コマンドをオートコンプリートするには Tabを使用します

MongoDB CLI コマンドのオートコンプリートを有効にすると、使用可能なコマンドとその構文を shell で直接確認できます。

Homebrew を使用して MongoDB CLI をインストールした場合、インストールにオートコンプリート機能が含まれています。 完了サポートを有効にするには、shell を構成する必要があります。 shell でオートコンプリートを有効にするには、 Homebrew ドキュメント を参照してください。

Homebrew を使用して MongoDB CLI をインストールしなかった場合、オートコンプリートを有効にする手順は、MongoDB CLI を実行する shell によって異なります。

zshを使用して MongoDB CLI を実行する場合は、次のコマンドを実行して、現在の shell でオートコンプリートを有効にします。

% echo "autoload -U compinit; compinit" >> ~/.zshrc

今後のすべての shell セッションでオートコンプリートを有効にするには、次の手順に従います。

    • MacOS を使用している場合は、次のコマンドを実行します。

      % mongocli completion zsh > /usr/local/share/zsh/site-functions/_mongocli
    • Linux を使用している場合は、次のコマンドを実行します。

      % mongocli completion zsh > "${fpath[1]}/_mongocli"
  1. 設定を有効にするために新しい shell を起動します。

Bash を使用して MongoDB CLI を実行する場合は、OS のパッケージ マネージャーを使用してbash-completionパッケージをインストールします。 次に、次のコマンドを実行して、現在の shell でオートコンプリートを有効にします。

$ source <(mongocli completion bash)

今後のすべての shell セッションでオートコンプリートを有効にするには、次の手順に従います。

    • MacOS を使用している場合は、次のコマンドを実行します。

      $ mongocli completion bash > /usr/local/etc/bash_completion.d/mongocli
    • Linux を使用している場合は、次のコマンドを実行します。

      $ mongocli completion bash > /etc/bash_completion.d/mongocli
  1. 設定を有効にするために新しい shell を起動します。

fishを使用して MongoDB CLI を実行する場合は、次のコマンドを実行して、現在の shell でオートコンプリートを有効にします。

> mongocli completion fish | source

今後のすべての shell セッションでオートコンプリートを有効にするには、次の手順に従います。

  1. 次のコマンドを実行します:

    > mongocli completion fish > ~/.config/fish/completions/mongocli.fish
  2. 設定を有効にするために新しい shell を起動します。

PowerShell を使用して MongoDB CLI を実行する場合は、次のコマンドを実行して、現在の shell でオートコンプリートを有効にします。

PS C:\> mongocli completion powershell | Out-String | Invoke-Expression

今後のすべての shell でオートコンプリートを有効にするには、上記のコマンドの出力を PowerShell プロファイルに追加します。 PowerShell プロファイルを編集する方法については、 Windows ドキュメント を参照してください。

オートコンプリートを構成すると、shell にmongocliと入力し、 Tabキーを押して、コマンドをオートコンプリートできます。 利用可能なオートコンプリート オプションを繰り返し使用するには、 Tabを複数回押します。

コマンドを作成している任意の段階でTabを押して、使用可能なオートコンプリート オプションを確認できます。

shell でmongocliと入力し、 Tabを押すと、出力は次のようになります。

atlas -- Atlas operations.
cloud-manager -- Cloud Manager operations.
completion -- Generate shell completion scripts
config -- Configure a profile to store access settings for your MongoDB deployment.
help -- Help about any command
iam -- Organization and projects operations.
ops-manager -- Ops Manager operations.

コマンドの一部としてatlasなどの特定のプロパティを入力すると、選択したプロパティのオートコンプリート オプションが表示されます。

たとえば、shell でmongocli atlasと入力してTabを押すと、出力は次のようになります。

accessLists -- Manage the IP access list for your project.
accessLogs -- Manage the access logs of a cluster.
alerts -- Manage alerts for your project.
backups -- Manage backups for your project.
clusters -- Manage clusters for your project.
dbusers -- Manage database users for your project.
events -- Manage events for your project.
logs -- Download host logs for your project.
metrics -- Get measurements on the state of the MongoDB process.
processes -- Manage MongoDB processes for your project.

戻る

環境変数