Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas completion zsh

On this page

  • Syntax
  • Options
  • Inherited Options

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 <(atlas completion zsh)

To load completions for every new session, execute once:

#### Linux:

atlas completion zsh > "${fpath[1]}/_atlas"

#### macOS:

atlas completion zsh > $(brew --prefix)/share/zsh/site-functions/_atlas

You will need to start a new shell for this setup to take effect.

Command Syntax
atlas completion zsh [options]
Name
Type
Required
Description

-h, --help

false

help for zsh

--no-descriptions

false

disable completion descriptions

Name
Type
Required
Description

-P, --profile

string

false

Name of 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.

Back

powershell