mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-14 00:06:02 -05:00
46 lines
1.2 KiB
ReStructuredText
46 lines
1.2 KiB
ReStructuredText
|
.. _mmctl_docs:
|
||
|
|
|
||
|
|
mmctl docs
|
||
|
|
----------
|
||
|
|
|
||
|
|
Generates mmctl documentation
|
||
|
|
|
||
|
|
Synopsis
|
||
|
|
~~~~~~~~
|
||
|
|
|
||
|
|
|
||
|
|
Generates mmctl documentation
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
mmctl docs [flags]
|
||
|
|
|
||
|
|
Options
|
||
|
|
~~~~~~~
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
-d, --directory string The directory where the docs would be generated in. (default "docs")
|
||
|
|
-h, --help help for docs
|
||
|
|
|
||
|
|
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 <mmctl.rst>`_ - Remote client for the Open Source, self-hosted Slack-alternative
|
||
|
|
|