mattermost/server/cmd/mmctl/docs/mmctl_completion_zsh.rst
Miguel de la Cruz 951456c780
Includes mmctl into the mono-repo (#23091)
* Includes mmctl into the mono-repo

* Update to use the new public module paths

* Adds docs check to the mmctl CI

* Fix public utils import path

* Tidy up modules

* Fix linter

* Update CI tasks to use the new file structure

* Update CI references
2023-06-05 12:42:55 +02:00

49 lines
1.3 KiB
ReStructuredText

.. _mmctl_completion_zsh:
mmctl completion zsh
--------------------
Generates the zsh autocompletion scripts
Synopsis
~~~~~~~~
To load completion, run
. <(mmctl completion zsh)
To configure your zsh shell to load completions for each session, add the above line to your ~/.zshrc
::
mmctl completion zsh [flags]
Options
~~~~~~~
::
-h, --help help for zsh
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
--disable-pager disables paged output
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
--insecure-tls-version allows to use TLS versions 1.0 and 1.1
--json the output format will be in json format
--local allows communicating with the server through a unix socket
--quiet prevent mmctl to generate output for the commands
--strict will only run commands if the mmctl version matches the server one
--suppress-warnings disables printing warning messages
SEE ALSO
~~~~~~~~
* `mmctl completion <mmctl_completion.rst>`_ - Generates autocompletion scripts for bash and zsh