文档菜单
文档首页
/
MongoDB Atlas
/
MongoDB CLI
/
配置

为MongoDB CLI启用自动完成

本页内容

  • 启用自动完成
  • 使用Tab键自动完成命令

您可以为MongoDB CLI命令启用自动完成，以便直接在您的shell中查看可用命令及其语法。

启用自动完成

如果您使用Homebrew安装了MongoDB CLI，自动完成功能包含在安装中。您必须配置您的shell以启用其完成支持。要为您的shell启用自动完成，请参阅Homebrew 文档.

如果您未使用Homebrew安装MongoDB CLI，启用自动完成的步骤取决于您运行MongoDB CLI的shell。

Z 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"

  2. 启动新的shell以使设置生效。

bash

如果您使用bash运行MongoDB CLI，请通过操作系统包管理器安装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

  2. 启动新的shell以使设置生效。

fish

如果您使用fish运行MongoDB CLI，请运行以下命令以在当前shell中启用自动补全：

> mongocli completion fish | source

要为所有未来shell会话启用自动完成

  1. 运行以下命令

    > mongocli completion fish > ~/.config/fish/completions/mongocli.fish

  2. 启动新的shell以使设置生效。

PowerShell

如果您使用PowerShell运行MongoDB CLI，请运行以下命令以在当前shell中启用自动补全：

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

要为所有未来的shell启用自动完成，请将上述命令的输出添加到您的PowerShell配置文件中。有关如何编辑PowerShell配置文件的说明，请参阅Windows文档。

使用 Tab 键自动完成命令

一旦您已配置自动完成，您可以通过在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.

返回

环境变量

下一页

自定义输出