diff options
Diffstat (limited to 'plugins/mongocli/README.md')
-rw-r--r-- | plugins/mongocli/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/mongocli/README.md b/plugins/mongocli/README.md new file mode 100644 index 000000000..e245f2a4a --- /dev/null +++ b/plugins/mongocli/README.md @@ -0,0 +1,19 @@ +# mongocli plugin + +The plugin adds several aliases for common [mongocli](https://docs.mongodb.com/mongocli/stable/) commands. + +To use it, add `mongocli` to the plugins array of your zshrc file: + +```zsh +plugins=(... mongocli) +``` + +## Aliases + +| Alias | Command | Description | +|----------|-------------------------------------------------------------|--------------------------------------------------------| +| `ma` | `mongocli atlas` | Shortcut for mongocli Atlas commands. | +| `mcm` | `mongocli cloud-manager` | Shortcut for mongocli Cloud Manager commands. | +| `mom` | `mongocli ops-manager` | Shortcut for mongocli Cloud Manager commands. | +| `miam` | `mongocli iam` | Shortcut for mongocli IAM commands. | + |