mongocli completion zsh
On this page
This version of the documentation is archived and no longer supported. View the current documentation to learn how to update your version of the MongoDB CLI.
Generate the autocompletion script for zsh
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(mongocli completion zsh); compdef _mongocli mongocli
To load completions for every new session, execute once:
#### Linux:
mongocli completion zsh > "${fpath[1]}/_mongocli"
#### macOS:
mongocli completion zsh > $(brew --prefix)/share/zsh/site-functions/_mongocli
You will need to start a new shell for this setup to take effect.
Syntax
mongocli completion zsh [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for zsh | |
--no-descriptions | false | disable completion descriptions |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |