.. _mongocli-completion-zsh:

=======================
mongocli completion zsh
=======================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

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)

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

.. code-block::
   :caption: Command Syntax

   mongocli completion zsh [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
   :header-rows: 1
   :widths: 20 10 10 60

   * - Name
     - Type
     - Required
     - Description
   * - -h, --help
     - 
     - false
     - help for zsh
   * - --no-descriptions
     - 
     - false
     - disable completion descriptions

Inherited Options
-----------------

.. list-table::
   :header-rows: 1
   :widths: 20 10 10 60

   * - Name
     - Type
     - Required
     - Description
   * - -P, --profile
     - string
     - false
     - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

