为 MongoDB CLI 启用自动完成功能
在此页面上
此版本的文档已存档,不再提供支持。查看最新文档,学习;了解如何升级MongoCLI 版本。
您可以为 MongoDB CLI 命令启用自动完成功能,以直接在 shell 中查看可用命令及其语法。
启用自动完成功能
如果您使用 Homebrew 安装了MongoDB CLI ,则安装中包含自动完成功能。您必须配置Shell以启用其完成支持。要为Shell启用autocomplete,请参阅 Homebrew 文档。
如果 不是与MongoDB CLI Homebrew 一起安装的,则启用自动完成的过程取决于运行shell 的MongoDB CLI 。
Z shell
如果使用 zsh
运行MongoDB CLI,请将以下内容添加到~/.zshrc
中:
autoload -Uz compinit compinit source <(mongocli completion zsh) compdef _mongocli mongocli
运行以下命令以重新加载您的zsh
配置文件:
source ~/.zshrc
Bash
如果使用 Bash运行MongoDB CLI,请将以下内容添加到~/.bash_profile
中:
eval "$(mongocli completion bash)"
运行以下命令以重新加载 Bash 配置文件:
source ~/.bash_profile
使用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.