snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
This commit is contained in:
65
server/cmd/mmctl/docs/mmctl.rst
Normal file
65
server/cmd/mmctl/docs/mmctl.rst
Normal file
@@ -0,0 +1,65 @@
|
||||
.. _mmctl:
|
||||
|
||||
mmctl
|
||||
-----
|
||||
|
||||
Remote client for the Open Source, self-hosted Slack-alternative
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Mattermost offers workplace messaging across web, PC and phones with archiving, search and integration with your existing systems. Documentation available at https://docs.mattermost.com
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
|
||||
--disable-pager disables paged output
|
||||
-h, --help help for mmctl
|
||||
--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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
* `mmctl bot <mmctl_bot.rst>`_ - Management of bots
|
||||
* `mmctl channel <mmctl_channel.rst>`_ - Management of channels
|
||||
* `mmctl command <mmctl_command.rst>`_ - Management of slash commands
|
||||
* `mmctl completion <mmctl_completion.rst>`_ - Generate the autocompletion script for the specified shell
|
||||
* `mmctl compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
* `mmctl config <mmctl_config.rst>`_ - Configuration
|
||||
* `mmctl docs <mmctl_docs.rst>`_ - Generates mmctl documentation
|
||||
* `mmctl export <mmctl_export.rst>`_ - Management of exports
|
||||
* `mmctl extract <mmctl_extract.rst>`_ - Management of content extraction job.
|
||||
* `mmctl group <mmctl_group.rst>`_ - Management of groups
|
||||
* `mmctl import <mmctl_import.rst>`_ - Management of imports
|
||||
* `mmctl integrity <mmctl_integrity.rst>`_ - Check database records integrity.
|
||||
* `mmctl job <mmctl_job.rst>`_ - Management of jobs
|
||||
* `mmctl ldap <mmctl_ldap.rst>`_ - LDAP related utilities
|
||||
* `mmctl license <mmctl_license.rst>`_ - Licensing commands
|
||||
* `mmctl logs <mmctl_logs.rst>`_ - Display logs in a human-readable format
|
||||
* `mmctl oauth <mmctl_oauth.rst>`_ - Management of OAuth2 apps
|
||||
* `mmctl permissions <mmctl_permissions.rst>`_ - Management of permissions
|
||||
* `mmctl plugin <mmctl_plugin.rst>`_ - Management of plugins
|
||||
* `mmctl post <mmctl_post.rst>`_ - Management of posts
|
||||
* `mmctl report <mmctl_report.rst>`_ - Reporting commands
|
||||
* `mmctl roles <mmctl_roles.rst>`_ - Manage user roles
|
||||
* `mmctl saml <mmctl_saml.rst>`_ - SAML related utilities
|
||||
* `mmctl sampledata <mmctl_sampledata.rst>`_ - Generate sample data
|
||||
* `mmctl system <mmctl_system.rst>`_ - System management
|
||||
* `mmctl team <mmctl_team.rst>`_ - Management of teams
|
||||
* `mmctl token <mmctl_token.rst>`_ - manage users' access tokens
|
||||
* `mmctl user <mmctl_user.rst>`_ - Management of users
|
||||
* `mmctl version <mmctl_version.rst>`_ - Prints the version of mmctl.
|
||||
* `mmctl webhook <mmctl_webhook.rst>`_ - Management of webhooks
|
||||
* `mmctl websocket <mmctl_websocket.rst>`_ - Display websocket in a human-readable format
|
||||
|
||||
47
server/cmd/mmctl/docs/mmctl_auth.rst
Normal file
47
server/cmd/mmctl/docs/mmctl_auth.rst
Normal file
@@ -0,0 +1,47 @@
|
||||
.. _mmctl_auth:
|
||||
|
||||
mmctl auth
|
||||
----------
|
||||
|
||||
Manages the credentials of the remote Mattermost instances
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Manages the credentials of the remote Mattermost instances
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for auth
|
||||
|
||||
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
|
||||
* `mmctl auth clean <mmctl_auth_clean.rst>`_ - Clean all credentials
|
||||
* `mmctl auth current <mmctl_auth_current.rst>`_ - Show current user credentials
|
||||
* `mmctl auth delete <mmctl_auth_delete.rst>`_ - Delete an credentials
|
||||
* `mmctl auth list <mmctl_auth_list.rst>`_ - Lists the credentials
|
||||
* `mmctl auth login <mmctl_auth_login.rst>`_ - Login into an instance
|
||||
* `mmctl auth renew <mmctl_auth_renew.rst>`_ - Renews a set of credentials
|
||||
* `mmctl auth set <mmctl_auth_set.rst>`_ - Set the credentials to use
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_auth_clean.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_auth_clean.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_auth_clean:
|
||||
|
||||
mmctl auth clean
|
||||
----------------
|
||||
|
||||
Clean all credentials
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Clean the currently stored credentials
|
||||
|
||||
::
|
||||
|
||||
mmctl auth clean [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth clean
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for clean
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_auth_current.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_auth_current.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_auth_current:
|
||||
|
||||
mmctl auth current
|
||||
------------------
|
||||
|
||||
Show current user credentials
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show the currently stored user credentials
|
||||
|
||||
::
|
||||
|
||||
mmctl auth current [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth current
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for current
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_auth_delete.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_auth_delete.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_auth_delete:
|
||||
|
||||
mmctl auth delete
|
||||
-----------------
|
||||
|
||||
Delete an credentials
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Delete an credentials by its name
|
||||
|
||||
::
|
||||
|
||||
mmctl auth delete [server name] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth delete local-server
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for delete
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_auth_list.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_auth_list.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_auth_list:
|
||||
|
||||
mmctl auth list
|
||||
---------------
|
||||
|
||||
Lists the credentials
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Print a list of the registered credentials
|
||||
|
||||
::
|
||||
|
||||
mmctl auth list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth list
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
60
server/cmd/mmctl/docs/mmctl_auth_login.rst
Normal file
60
server/cmd/mmctl/docs/mmctl_auth_login.rst
Normal file
@@ -0,0 +1,60 @@
|
||||
.. _mmctl_auth_login:
|
||||
|
||||
mmctl auth login
|
||||
----------------
|
||||
|
||||
Login into an instance
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Login into an instance and store credentials
|
||||
|
||||
::
|
||||
|
||||
mmctl auth login [instance url] --name [server name] --username [username] --password-file [password-file] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth login https://mattermost.example.com
|
||||
auth login https://mattermost.example.com --name local-server --username sysadmin --password-file mysupersecret.txt
|
||||
auth login https://mattermost.example.com --name local-server --username sysadmin --password-file mysupersecret.txt --mfa-token 123456
|
||||
auth login https://mattermost.example.com --name local-server --access-token myaccesstoken
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-t, --access-token-file string Access token file to be read to use instead of username/password
|
||||
-h, --help help for login
|
||||
-m, --mfa-token string MFA token for the credentials
|
||||
-n, --name string Name for the credentials
|
||||
--no-activate If present, it won't activate the credentials after login
|
||||
-f, --password-file string Password file to be read for the credentials
|
||||
-u, --username string Username for the credentials
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_auth_renew.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_auth_renew.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_auth_renew:
|
||||
|
||||
mmctl auth renew
|
||||
----------------
|
||||
|
||||
Renews a set of credentials
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Renews the credentials for a given server
|
||||
|
||||
::
|
||||
|
||||
mmctl auth renew [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth renew local-server
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-t, --access-token-file string Access token file to be read to use instead of username/password
|
||||
-h, --help help for renew
|
||||
-m, --mfa-token string MFA token for the credentials
|
||||
-f, --password-file string Password file to be read for the credentials
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_auth_set.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_auth_set.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_auth_set:
|
||||
|
||||
mmctl auth set
|
||||
--------------
|
||||
|
||||
Set the credentials to use
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Set an credentials to use in the following commands
|
||||
|
||||
::
|
||||
|
||||
mmctl auth set [server name] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
auth set local-server
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for set
|
||||
|
||||
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 auth <mmctl_auth.rst>`_ - Manages the credentials of the remote Mattermost instances
|
||||
|
||||
46
server/cmd/mmctl/docs/mmctl_bot.rst
Normal file
46
server/cmd/mmctl/docs/mmctl_bot.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
.. _mmctl_bot:
|
||||
|
||||
mmctl bot
|
||||
---------
|
||||
|
||||
Management of bots
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of bots
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for bot
|
||||
|
||||
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
|
||||
* `mmctl bot assign <mmctl_bot_assign.rst>`_ - Assign bot
|
||||
* `mmctl bot create <mmctl_bot_create.rst>`_ - Create bot
|
||||
* `mmctl bot disable <mmctl_bot_disable.rst>`_ - Disable bot
|
||||
* `mmctl bot enable <mmctl_bot_enable.rst>`_ - Enable bot
|
||||
* `mmctl bot list <mmctl_bot_list.rst>`_ - List bots
|
||||
* `mmctl bot update <mmctl_bot_update.rst>`_ - Update bot
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_bot_assign.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_bot_assign.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_bot_assign:
|
||||
|
||||
mmctl bot assign
|
||||
----------------
|
||||
|
||||
Assign bot
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Assign the ownership of a bot to another user
|
||||
|
||||
::
|
||||
|
||||
mmctl bot assign [bot-username] [new-owner-username] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
bot assign testbot user2
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for assign
|
||||
|
||||
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 bot <mmctl_bot.rst>`_ - Management of bots
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_bot_create.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_bot_create.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_bot_create:
|
||||
|
||||
mmctl bot create
|
||||
----------------
|
||||
|
||||
Create bot
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Create bot.
|
||||
|
||||
::
|
||||
|
||||
mmctl bot create [username] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
bot create testbot
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--description string Optional. The description text for the new bot.
|
||||
--display-name string Optional. The display name for the new bot.
|
||||
-h, --help help for create
|
||||
--with-token Optional. Auto genreate access token for the bot.
|
||||
|
||||
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 bot <mmctl_bot.rst>`_ - Management of bots
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_bot_disable.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_bot_disable.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_bot_disable:
|
||||
|
||||
mmctl bot disable
|
||||
-----------------
|
||||
|
||||
Disable bot
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Disable an enabled bot
|
||||
|
||||
::
|
||||
|
||||
mmctl bot disable [username] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
bot disable testbot
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for disable
|
||||
|
||||
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 bot <mmctl_bot.rst>`_ - Management of bots
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_bot_enable.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_bot_enable.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_bot_enable:
|
||||
|
||||
mmctl bot enable
|
||||
----------------
|
||||
|
||||
Enable bot
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Enable a disabled bot
|
||||
|
||||
::
|
||||
|
||||
mmctl bot enable [username] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
bot enable testbot
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for enable
|
||||
|
||||
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 bot <mmctl_bot.rst>`_ - Management of bots
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_bot_list.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_bot_list.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_bot_list:
|
||||
|
||||
mmctl bot list
|
||||
--------------
|
||||
|
||||
List bots
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List the bots users.
|
||||
|
||||
::
|
||||
|
||||
mmctl bot list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
bot list
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all Optional. Show all bots (including deleleted and orphaned).
|
||||
-h, --help help for list
|
||||
--orphaned Optional. Only show orphaned bots.
|
||||
|
||||
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 bot <mmctl_bot.rst>`_ - Management of bots
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_bot_update.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_bot_update.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_bot_update:
|
||||
|
||||
mmctl bot update
|
||||
----------------
|
||||
|
||||
Update bot
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Update bot information.
|
||||
|
||||
::
|
||||
|
||||
mmctl bot update [username] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
bot update testbot --username newbotusername
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--description string Optional. The new description text for the bot.
|
||||
--display-name string Optional. The new display name for the bot.
|
||||
-h, --help help for update
|
||||
--username string Optional. The new username for the bot.
|
||||
|
||||
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 bot <mmctl_bot.rst>`_ - Management of bots
|
||||
|
||||
50
server/cmd/mmctl/docs/mmctl_channel.rst
Normal file
50
server/cmd/mmctl/docs/mmctl_channel.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. _mmctl_channel:
|
||||
|
||||
mmctl channel
|
||||
-------------
|
||||
|
||||
Management of channels
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of channels
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for channel
|
||||
|
||||
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
|
||||
* `mmctl channel archive <mmctl_channel_archive.rst>`_ - Archive channels
|
||||
* `mmctl channel create <mmctl_channel_create.rst>`_ - Create a channel
|
||||
* `mmctl channel delete <mmctl_channel_delete.rst>`_ - Delete channels
|
||||
* `mmctl channel list <mmctl_channel_list.rst>`_ - List all channels on specified teams.
|
||||
* `mmctl channel modify <mmctl_channel_modify.rst>`_ - Modify a channel's public/private type
|
||||
* `mmctl channel move <mmctl_channel_move.rst>`_ - Moves channels to the specified team
|
||||
* `mmctl channel rename <mmctl_channel_rename.rst>`_ - Rename channel
|
||||
* `mmctl channel search <mmctl_channel_search.rst>`_ - Search a channel
|
||||
* `mmctl channel unarchive <mmctl_channel_unarchive.rst>`_ - Unarchive some channels
|
||||
* `mmctl channel users <mmctl_channel_users.rst>`_ - Management of channel users
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_channel_archive.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_channel_archive.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_channel_archive:
|
||||
|
||||
mmctl channel archive
|
||||
---------------------
|
||||
|
||||
Archive channels
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Archive some channels.
|
||||
Archive a channel along with all related information including posts from the database.
|
||||
Channels can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel archive [channels] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel archive myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for archive
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
58
server/cmd/mmctl/docs/mmctl_channel_create.rst
Normal file
58
server/cmd/mmctl/docs/mmctl_channel_create.rst
Normal file
@@ -0,0 +1,58 @@
|
||||
.. _mmctl_channel_create:
|
||||
|
||||
mmctl channel create
|
||||
--------------------
|
||||
|
||||
Create a channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Create a channel.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel create [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel create --team myteam --name mynewchannel --display-name "My New Channel"
|
||||
channel create --team myteam --name mynewprivatechannel --display-name "My New Private Channel" --private
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--display-name string Channel Display Name
|
||||
--header string Channel header
|
||||
-h, --help help for create
|
||||
--name string Channel Name
|
||||
--private Create a private channel.
|
||||
--purpose string Channel purpose
|
||||
--team string Team name or ID
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_channel_delete.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_channel_delete.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_channel_delete:
|
||||
|
||||
mmctl channel delete
|
||||
--------------------
|
||||
|
||||
Delete channels
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Permanently delete some channels.
|
||||
Permanently deletes one or multiple channels along with all related information including posts from the database.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel delete [channels] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel delete myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--confirm Confirm you really want to delete the channel and a DB backup has been performed.
|
||||
-h, --help help for delete
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_channel_list.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_channel_list.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_channel_list:
|
||||
|
||||
mmctl channel list
|
||||
------------------
|
||||
|
||||
List all channels on specified teams.
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List all channels on specified teams.
|
||||
Archived channels are appended with ' (archived)'.
|
||||
Private channels the user is a member of or has access to are appended with ' (private)'.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel list [teams] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel list myteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
-i, --show-ids Show channel IDs
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
55
server/cmd/mmctl/docs/mmctl_channel_modify.rst
Normal file
55
server/cmd/mmctl/docs/mmctl_channel_modify.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. _mmctl_channel_modify:
|
||||
|
||||
mmctl channel modify
|
||||
--------------------
|
||||
|
||||
Modify a channel's public/private type
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Change the Public/Private type of a channel.
|
||||
Channel can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel modify [channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel modify myteam:mychannel --private
|
||||
channel modify channelId --public
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for modify
|
||||
--private Convert the channel to a private channel
|
||||
--public Convert the channel to a public channel
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
55
server/cmd/mmctl/docs/mmctl_channel_move.rst
Normal file
55
server/cmd/mmctl/docs/mmctl_channel_move.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. _mmctl_channel_move:
|
||||
|
||||
mmctl channel move
|
||||
------------------
|
||||
|
||||
Moves channels to the specified team
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Moves the provided channels to the specified team.
|
||||
Validates that all users in the channel belong to the target team. If some users are not members of the target team, the move fails and the missing users are listed; use --auto-add-users to add them to the target team automatically, or --force to remove them from the channel. Incoming/Outgoing webhooks are moved along with the channel.
|
||||
Channels can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel move [team] [channels] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel move newteam oldteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--auto-add-users Add users that are not members of the target team to it before moving the channel.
|
||||
--force Remove users that are not members of target team before moving the channel.
|
||||
-h, --help help for move
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
55
server/cmd/mmctl/docs/mmctl_channel_rename.rst
Normal file
55
server/cmd/mmctl/docs/mmctl_channel_rename.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. _mmctl_channel_rename:
|
||||
|
||||
mmctl channel rename
|
||||
--------------------
|
||||
|
||||
Rename channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Rename an existing channel.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel rename [channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel rename myteam:oldchannel --name 'new-channel' --display-name 'New Display Name'
|
||||
channel rename myteam:oldchannel --name 'new-channel'
|
||||
channel rename myteam:oldchannel --display-name 'New Display Name'
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--display-name string Channel Display Name
|
||||
-h, --help help for rename
|
||||
--name string Channel Name
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
55
server/cmd/mmctl/docs/mmctl_channel_search.rst
Normal file
55
server/cmd/mmctl/docs/mmctl_channel_search.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. _mmctl_channel_search:
|
||||
|
||||
mmctl channel search
|
||||
--------------------
|
||||
|
||||
Search a channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Search a channel by channel name.
|
||||
Channel can be specified by team. ie. --team myteam mychannel or by team ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel search [channel]
|
||||
mmctl search --team [team] [channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel search mychannel
|
||||
channel search --team myteam mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for search
|
||||
--team string Team name or ID
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
52
server/cmd/mmctl/docs/mmctl_channel_unarchive.rst
Normal file
52
server/cmd/mmctl/docs/mmctl_channel_unarchive.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
.. _mmctl_channel_unarchive:
|
||||
|
||||
mmctl channel unarchive
|
||||
-----------------------
|
||||
|
||||
Unarchive some channels
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Unarchive a previously archived channel
|
||||
Channels can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl channel unarchive [channels] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel unarchive myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for unarchive
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
|
||||
43
server/cmd/mmctl/docs/mmctl_channel_users.rst
Normal file
43
server/cmd/mmctl/docs/mmctl_channel_users.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. _mmctl_channel_users:
|
||||
|
||||
mmctl channel users
|
||||
-------------------
|
||||
|
||||
Management of channel users
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of channel users
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for users
|
||||
|
||||
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 channel <mmctl_channel.rst>`_ - Management of channels
|
||||
* `mmctl channel users add <mmctl_channel_users_add.rst>`_ - Add users to channel
|
||||
* `mmctl channel users list <mmctl_channel_users_list.rst>`_ - List users of a channel
|
||||
* `mmctl channel users remove <mmctl_channel_users_remove.rst>`_ - Remove users from channel
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_channel_users_add.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_channel_users_add.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_channel_users_add:
|
||||
|
||||
mmctl channel users add
|
||||
-----------------------
|
||||
|
||||
Add users to channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Add some users to channel
|
||||
|
||||
::
|
||||
|
||||
mmctl channel users add [channel] [users] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel users add myteam:mychannel user@example.com username
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for add
|
||||
|
||||
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 channel users <mmctl_channel_users.rst>`_ - Management of channel users
|
||||
|
||||
55
server/cmd/mmctl/docs/mmctl_channel_users_list.rst
Normal file
55
server/cmd/mmctl/docs/mmctl_channel_users_list.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. _mmctl_channel_users_list:
|
||||
|
||||
mmctl channel users list
|
||||
------------------------
|
||||
|
||||
List users of a channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List the users belonging to a channel, printing each member's id, username, email and roles
|
||||
|
||||
::
|
||||
|
||||
mmctl channel users list [channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel users list myteam:mychannel
|
||||
channel users list myteam:mychannel --all
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all Fetch all channel users. --page flag will be ignored if provided
|
||||
-h, --help help for list
|
||||
--page int Page number to fetch for the list of channel users
|
||||
--per-page int Number of channel users to be fetched (default 200)
|
||||
|
||||
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 channel users <mmctl_channel_users.rst>`_ - Management of channel users
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_channel_users_remove.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_channel_users_remove.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_channel_users_remove:
|
||||
|
||||
mmctl channel users remove
|
||||
--------------------------
|
||||
|
||||
Remove users from channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Remove some users from channel
|
||||
|
||||
::
|
||||
|
||||
mmctl channel users remove [channel] [users] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
channel users remove myteam:mychannel user@example.com username
|
||||
channel users remove myteam:mychannel --all-users
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all-users Remove all users from the indicated channel.
|
||||
-h, --help help for remove
|
||||
|
||||
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 channel users <mmctl_channel_users.rst>`_ - Management of channel users
|
||||
|
||||
46
server/cmd/mmctl/docs/mmctl_command.rst
Normal file
46
server/cmd/mmctl/docs/mmctl_command.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
.. _mmctl_command:
|
||||
|
||||
mmctl command
|
||||
-------------
|
||||
|
||||
Management of slash commands
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of slash commands
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for command
|
||||
|
||||
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
|
||||
* `mmctl command archive <mmctl_command_archive.rst>`_ - Archive a slash command
|
||||
* `mmctl command create <mmctl_command_create.rst>`_ - Create a custom slash command
|
||||
* `mmctl command list <mmctl_command_list.rst>`_ - List all commands on specified teams.
|
||||
* `mmctl command modify <mmctl_command_modify.rst>`_ - Modify a slash command
|
||||
* `mmctl command move <mmctl_command_move.rst>`_ - Move a slash command to a different team
|
||||
* `mmctl command show <mmctl_command_show.rst>`_ - Show a custom slash command
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_command_archive.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_command_archive.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_command_archive:
|
||||
|
||||
mmctl command archive
|
||||
---------------------
|
||||
|
||||
Archive a slash command
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Archive a slash command. Commands can be specified by command ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl command archive [commandID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
command archive commandID
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for archive
|
||||
|
||||
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 command <mmctl_command.rst>`_ - Management of slash commands
|
||||
|
||||
62
server/cmd/mmctl/docs/mmctl_command_create.rst
Normal file
62
server/cmd/mmctl/docs/mmctl_command_create.rst
Normal file
@@ -0,0 +1,62 @@
|
||||
.. _mmctl_command_create:
|
||||
|
||||
mmctl command create
|
||||
--------------------
|
||||
|
||||
Create a custom slash command
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Create a custom slash command for the specified team.
|
||||
|
||||
::
|
||||
|
||||
mmctl command create [team] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
command create myteam --title MyCommand --description "My Command Description" --trigger-word mycommand --url http://localhost:8000/my-slash-handler --creator myusername --response-username my-bot-username --icon http://localhost:8000/my-slash-handler-bot-icon.png --autocomplete --post
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--autocomplete Show Command in autocomplete list
|
||||
--autocompleteDesc string Short Command Description for autocomplete list
|
||||
--autocompleteHint string Command Arguments displayed as help in autocomplete list
|
||||
--creator string Command Creator's username, email or id (required)
|
||||
--description string Command Description
|
||||
-h, --help help for create
|
||||
--icon string Command Icon URL
|
||||
--post Use POST method for Callback URL
|
||||
--response-username string Command Response Username
|
||||
--title string Command Title
|
||||
--trigger-word string Command Trigger Word (required)
|
||||
--url string Command Callback URL (required)
|
||||
|
||||
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 command <mmctl_command.rst>`_ - Management of slash commands
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_command_list.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_command_list.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_command_list:
|
||||
|
||||
mmctl command list
|
||||
------------------
|
||||
|
||||
List all commands on specified teams.
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List all commands on specified teams.
|
||||
|
||||
::
|
||||
|
||||
mmctl command list [teams] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
command list myteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
|
||||
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 command <mmctl_command.rst>`_ - Management of slash commands
|
||||
|
||||
62
server/cmd/mmctl/docs/mmctl_command_modify.rst
Normal file
62
server/cmd/mmctl/docs/mmctl_command_modify.rst
Normal file
@@ -0,0 +1,62 @@
|
||||
.. _mmctl_command_modify:
|
||||
|
||||
mmctl command modify
|
||||
--------------------
|
||||
|
||||
Modify a slash command
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Modify a slash command. Commands can be specified by command ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl command modify [commandID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
command modify commandID --title MyModifiedCommand --description "My Modified Command Description" --trigger-word mycommand --url http://localhost:8000/my-slash-handler --creator myusername --response-username my-bot-username --icon http://localhost:8000/my-slash-handler-bot-icon.png --autocomplete --post
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--autocomplete Show Command in autocomplete list
|
||||
--autocompleteDesc string Short Command Description for autocomplete list
|
||||
--autocompleteHint string Command Arguments displayed as help in autocomplete list
|
||||
--creator string Command Creator's username, email or id (required)
|
||||
--description string Command Description
|
||||
-h, --help help for modify
|
||||
--icon string Command Icon URL
|
||||
--post Use POST method for Callback URL
|
||||
--response-username string Command Response Username
|
||||
--title string Command Title
|
||||
--trigger-word string Command Trigger Word (required)
|
||||
--url string Command Callback URL (required)
|
||||
|
||||
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 command <mmctl_command.rst>`_ - Management of slash commands
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_command_move.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_command_move.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_command_move:
|
||||
|
||||
mmctl command move
|
||||
------------------
|
||||
|
||||
Move a slash command to a different team
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Move a slash command to a different team. Commands can be specified by command ID.
|
||||
|
||||
::
|
||||
|
||||
mmctl command move [team] [commandID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
command move newteam commandID
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for move
|
||||
|
||||
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 command <mmctl_command.rst>`_ - Management of slash commands
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_command_show.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_command_show.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_command_show:
|
||||
|
||||
mmctl command show
|
||||
------------------
|
||||
|
||||
Show a custom slash command
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show a custom slash command. Commands can be specified by command ID. Returns command ID, team ID, trigger word, display name and creator username.
|
||||
|
||||
::
|
||||
|
||||
mmctl command show [commandID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
command show commandID
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for show
|
||||
|
||||
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 command <mmctl_command.rst>`_ - Management of slash commands
|
||||
|
||||
46
server/cmd/mmctl/docs/mmctl_completion.rst
Normal file
46
server/cmd/mmctl/docs/mmctl_completion.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
.. _mmctl_completion:
|
||||
|
||||
mmctl completion
|
||||
----------------
|
||||
|
||||
Generate the autocompletion script for the specified shell
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Generate the autocompletion script for mmctl for the specified shell.
|
||||
See each sub-command's help for details on how to use the generated script.
|
||||
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for completion
|
||||
|
||||
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
|
||||
* `mmctl completion bash <mmctl_completion_bash.rst>`_ - Generate the autocompletion script for bash
|
||||
* `mmctl completion fish <mmctl_completion_fish.rst>`_ - Generate the autocompletion script for fish
|
||||
* `mmctl completion powershell <mmctl_completion_powershell.rst>`_ - Generate the autocompletion script for powershell
|
||||
* `mmctl completion zsh <mmctl_completion_zsh.rst>`_ - Generate the autocompletion script for zsh
|
||||
|
||||
65
server/cmd/mmctl/docs/mmctl_completion_bash.rst
Normal file
65
server/cmd/mmctl/docs/mmctl_completion_bash.rst
Normal file
@@ -0,0 +1,65 @@
|
||||
.. _mmctl_completion_bash:
|
||||
|
||||
mmctl completion bash
|
||||
---------------------
|
||||
|
||||
Generate the autocompletion script for bash
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Generate the autocompletion script for the bash shell.
|
||||
|
||||
This script depends on the 'bash-completion' package.
|
||||
If it is not installed already, you can install it via your OS's package manager.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
source <(mmctl completion bash)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
mmctl completion bash > /etc/bash_completion.d/mmctl
|
||||
|
||||
#### macOS:
|
||||
|
||||
mmctl completion bash > $(brew --prefix)/etc/bash_completion.d/mmctl
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
::
|
||||
|
||||
mmctl completion bash
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for bash
|
||||
--no-descriptions disable completion descriptions
|
||||
|
||||
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>`_ - Generate the autocompletion script for the specified shell
|
||||
|
||||
56
server/cmd/mmctl/docs/mmctl_completion_fish.rst
Normal file
56
server/cmd/mmctl/docs/mmctl_completion_fish.rst
Normal file
@@ -0,0 +1,56 @@
|
||||
.. _mmctl_completion_fish:
|
||||
|
||||
mmctl completion fish
|
||||
---------------------
|
||||
|
||||
Generate the autocompletion script for fish
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Generate the autocompletion script for the fish shell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
mmctl completion fish | source
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
mmctl completion fish > ~/.config/fish/completions/mmctl.fish
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
::
|
||||
|
||||
mmctl completion fish [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for fish
|
||||
--no-descriptions disable completion descriptions
|
||||
|
||||
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>`_ - Generate the autocompletion script for the specified shell
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_completion_powershell.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_completion_powershell.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_completion_powershell:
|
||||
|
||||
mmctl completion powershell
|
||||
---------------------------
|
||||
|
||||
Generate the autocompletion script for powershell
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Generate the autocompletion script for powershell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
mmctl completion powershell | Out-String | Invoke-Expression
|
||||
|
||||
To load completions for every new session, add the output of the above command
|
||||
to your powershell profile.
|
||||
|
||||
|
||||
::
|
||||
|
||||
mmctl completion powershell [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for powershell
|
||||
--no-descriptions disable completion descriptions
|
||||
|
||||
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>`_ - Generate the autocompletion script for the specified shell
|
||||
|
||||
67
server/cmd/mmctl/docs/mmctl_completion_zsh.rst
Normal file
67
server/cmd/mmctl/docs/mmctl_completion_zsh.rst
Normal file
@@ -0,0 +1,67 @@
|
||||
.. _mmctl_completion_zsh:
|
||||
|
||||
mmctl completion zsh
|
||||
--------------------
|
||||
|
||||
Generate the autocompletion script for zsh
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
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 <(mmctl completion zsh)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
mmctl completion zsh > "${fpath[1]}/_mmctl"
|
||||
|
||||
#### macOS:
|
||||
|
||||
mmctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_mmctl
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
::
|
||||
|
||||
mmctl completion zsh [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for zsh
|
||||
--no-descriptions disable completion descriptions
|
||||
|
||||
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>`_ - Generate the autocompletion script for the specified shell
|
||||
|
||||
45
server/cmd/mmctl/docs/mmctl_compliance-export.rst
Normal file
45
server/cmd/mmctl/docs/mmctl_compliance-export.rst
Normal file
@@ -0,0 +1,45 @@
|
||||
.. _mmctl_compliance-export:
|
||||
|
||||
mmctl compliance-export
|
||||
-----------------------
|
||||
|
||||
Management of compliance exports
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of compliance exports
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for compliance-export
|
||||
|
||||
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
|
||||
* `mmctl compliance-export cancel <mmctl_compliance-export_cancel.rst>`_ - Cancel compliance export job
|
||||
* `mmctl compliance-export create <mmctl_compliance-export_create.rst>`_ - Create a compliance export job, of type 'csv' or 'actiance' or 'globalrelay'
|
||||
* `mmctl compliance-export download <mmctl_compliance-export_download.rst>`_ - Download compliance export file
|
||||
* `mmctl compliance-export list <mmctl_compliance-export_list.rst>`_ - List compliance export jobs, sorted by creation date descending (newest first)
|
||||
* `mmctl compliance-export show <mmctl_compliance-export_show.rst>`_ - Show compliance export job
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_compliance-export_cancel.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_compliance-export_cancel.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_compliance-export_cancel:
|
||||
|
||||
mmctl compliance-export cancel
|
||||
------------------------------
|
||||
|
||||
Cancel compliance export job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Cancel compliance export job
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance-export cancel [complianceExportJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
compliance-export cancel o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for cancel
|
||||
|
||||
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 compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
56
server/cmd/mmctl/docs/mmctl_compliance-export_create.rst
Normal file
56
server/cmd/mmctl/docs/mmctl_compliance-export_create.rst
Normal file
@@ -0,0 +1,56 @@
|
||||
.. _mmctl_compliance-export_create:
|
||||
|
||||
mmctl compliance-export create
|
||||
------------------------------
|
||||
|
||||
Create a compliance export job, of type 'csv' or 'actiance' or 'globalrelay'
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Create a compliance export job, of type 'csv' or 'actiance' or 'globalrelay'. If --date is set, the job will run for one day, from 12am to 12am (minus one millisecond) inclusively, in the format with timezone offset: `"YYYY-MM-DD -0000"`. E.g., "2024-10-21 -0400" for Oct 21, 2024 EDT timezone. "2023-11-01 +0000" for Nov 01, 2024 UTC. If set, the 'start' and 'end' flags will be ignored.
|
||||
|
||||
Important: Running a compliance export job from mmctl will NOT affect the next scheduled job's batch_start_time. This means that if you run a compliance export job from mmctl, the next scheduled job will run from the batch_end_time of the previous scheduled job, as usual.
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance-export create [complianceExportType] --date "2025-03-27 -0400" [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
compliance-export create csv --date "2025-03-27 -0400"
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--date "YYYY-MM-DD -0000" Run the export for one day, from 12am to 12am (minus one millisecond) inclusively, in the format with timezone offset: "YYYY-MM-DD -0000". E.g., `"2024-10-21 -0400"` for Oct 21, 2024 EDT timezone. `"2023-11-01 +0000"` for Nov 01, 2024 UTC. If set, the 'start' and 'end' flags will be ignored.
|
||||
--end 1743134400000 The end timestamp in unix milliseconds. Posts with updateAt <= end will be exported. If set, 'start' must be set as well. eg, 1743134400000 for 2025-03-28 EDT.
|
||||
-h, --help help for create
|
||||
--start 1743048000000 The start timestamp in unix milliseconds. Posts with updateAt >= start will be exported. If set, 'end' must be set as well. eg, 1743048000000 for 2025-03-27 EDT.
|
||||
|
||||
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 compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
52
server/cmd/mmctl/docs/mmctl_compliance-export_download.rst
Normal file
52
server/cmd/mmctl/docs/mmctl_compliance-export_download.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
.. _mmctl_compliance-export_download:
|
||||
|
||||
mmctl compliance-export download
|
||||
--------------------------------
|
||||
|
||||
Download compliance export file
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Download compliance export file
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance-export download [complianceExportJobID] [output filepath (optional)] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
compliance-export download o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for download
|
||||
--num-retries int Number of retries if the download fails (default 5)
|
||||
|
||||
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 compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
47
server/cmd/mmctl/docs/mmctl_compliance-export_list.rst
Normal file
47
server/cmd/mmctl/docs/mmctl_compliance-export_list.rst
Normal file
@@ -0,0 +1,47 @@
|
||||
.. _mmctl_compliance-export_list:
|
||||
|
||||
mmctl compliance-export list
|
||||
----------------------------
|
||||
|
||||
List compliance export jobs, sorted by creation date descending (newest first)
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List compliance export jobs, sorted by creation date descending (newest first)
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance-export list [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all Fetch all compliance export jobs. --page flag will be ignored if provided
|
||||
-h, --help help for list
|
||||
--page int Page number to fetch for the list of compliance export jobs
|
||||
--per-page int Number of compliance export jobs to be fetched (default 200)
|
||||
|
||||
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 compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_compliance-export_show.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_compliance-export_show.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_compliance-export_show:
|
||||
|
||||
mmctl compliance-export show
|
||||
----------------------------
|
||||
|
||||
Show compliance export job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show compliance export job
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance-export show [complianceExportJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
compliance-export show o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for show
|
||||
|
||||
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 compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
50
server/cmd/mmctl/docs/mmctl_config.rst
Normal file
50
server/cmd/mmctl/docs/mmctl_config.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. _mmctl_config:
|
||||
|
||||
mmctl config
|
||||
------------
|
||||
|
||||
Configuration
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Configuration
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for config
|
||||
|
||||
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
|
||||
* `mmctl config edit <mmctl_config_edit.rst>`_ - Edit the config
|
||||
* `mmctl config export <mmctl_config_export.rst>`_ - Export the server configuration
|
||||
* `mmctl config get <mmctl_config_get.rst>`_ - Get config setting
|
||||
* `mmctl config migrate <mmctl_config_migrate.rst>`_ - Migrate existing config between backends
|
||||
* `mmctl config patch <mmctl_config_patch.rst>`_ - Patch the config
|
||||
* `mmctl config reload <mmctl_config_reload.rst>`_ - Reload the server configuration
|
||||
* `mmctl config reset <mmctl_config_reset.rst>`_ - Reset config setting
|
||||
* `mmctl config set <mmctl_config_set.rst>`_ - Set config setting
|
||||
* `mmctl config show <mmctl_config_show.rst>`_ - Writes the server configuration to STDOUT
|
||||
* `mmctl config subpath <mmctl_config_subpath.rst>`_ - Update client asset loading to use the configured subpath
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_config_edit.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_config_edit.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_config_edit:
|
||||
|
||||
mmctl config edit
|
||||
-----------------
|
||||
|
||||
Edit the config
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Opens the editor defined in the EDITOR environment variable to modify the server's configuration and then uploads it
|
||||
|
||||
::
|
||||
|
||||
mmctl config edit [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config edit
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for edit
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_config_export.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_config_export.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_config_export:
|
||||
|
||||
mmctl config export
|
||||
-------------------
|
||||
|
||||
Export the server configuration
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Export the server configuration in case you want to import somewhere else.
|
||||
|
||||
::
|
||||
|
||||
mmctl config export [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config export --remove-masked --remove-defaults
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for export
|
||||
--remove-defaults remove default values from the exported configuration
|
||||
--remove-masked remove masked values from the exported configuration (default true)
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_config_get.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_config_get.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_config_get:
|
||||
|
||||
mmctl config get
|
||||
----------------
|
||||
|
||||
Get config setting
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Gets the value of a config setting by its name in dot notation.
|
||||
|
||||
::
|
||||
|
||||
mmctl config get [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config get SqlSettings.DriverName
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for get
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_config_migrate.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_config_migrate.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_config_migrate:
|
||||
|
||||
mmctl config migrate
|
||||
--------------------
|
||||
|
||||
Migrate existing config between backends
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Migrate a file-based configuration to (or from) a database-based configuration. Point the Mattermost server at the target configuration to start using it. Note that this command is only available in `--local` mode.
|
||||
|
||||
::
|
||||
|
||||
mmctl config migrate [from_config] [to_config] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config migrate path/to/config.json "postgres://mmuser:mostest_password@localhost:5432/mattermost_test?sslmode=disable&connect_timeout=10"
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for migrate
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_config_patch.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_config_patch.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_config_patch:
|
||||
|
||||
mmctl config patch
|
||||
------------------
|
||||
|
||||
Patch the config
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Patches config settings with the given config file.
|
||||
|
||||
::
|
||||
|
||||
mmctl config patch <config-file> [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config patch /path/to/config.json
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for patch
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_config_reload.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_config_reload.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_config_reload:
|
||||
|
||||
mmctl config reload
|
||||
-------------------
|
||||
|
||||
Reload the server configuration
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Reload the server configuration in case you want to new settings to be applied.
|
||||
|
||||
::
|
||||
|
||||
mmctl config reload [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config reload
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for reload
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
52
server/cmd/mmctl/docs/mmctl_config_reset.rst
Normal file
52
server/cmd/mmctl/docs/mmctl_config_reset.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
.. _mmctl_config_reset:
|
||||
|
||||
mmctl config reset
|
||||
------------------
|
||||
|
||||
Reset config setting
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Resets the value of a config setting by its name in dot notation or a setting section. Accepts multiple values for array settings.
|
||||
|
||||
::
|
||||
|
||||
mmctl config reset [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config reset SqlSettings.DriverName LogSettings
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--confirm confirm you really want to reset all configuration settings to its default value
|
||||
-h, --help help for reset
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
52
server/cmd/mmctl/docs/mmctl_config_set.rst
Normal file
52
server/cmd/mmctl/docs/mmctl_config_set.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
.. _mmctl_config_set:
|
||||
|
||||
mmctl config set
|
||||
----------------
|
||||
|
||||
Set config setting
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Sets the value of a config setting by its name in dot notation. Accepts multiple values for array settings
|
||||
|
||||
::
|
||||
|
||||
mmctl config set [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config set SqlSettings.DriverName postgres
|
||||
config set SqlSettings.DataSourceReplicas "replica1" "replica2"
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for set
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_config_show.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_config_show.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_config_show:
|
||||
|
||||
mmctl config show
|
||||
-----------------
|
||||
|
||||
Writes the server configuration to STDOUT
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Prints the server configuration and writes to STDOUT in JSON format.
|
||||
|
||||
::
|
||||
|
||||
mmctl config show [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
config show
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for show
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
60
server/cmd/mmctl/docs/mmctl_config_subpath.rst
Normal file
60
server/cmd/mmctl/docs/mmctl_config_subpath.rst
Normal file
@@ -0,0 +1,60 @@
|
||||
.. _mmctl_config_subpath:
|
||||
|
||||
mmctl config subpath
|
||||
--------------------
|
||||
|
||||
Update client asset loading to use the configured subpath
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Update the hard-coded production client asset paths to take into account Mattermost running on a subpath. This command needs access to the Mattermost assets directory to be able to rewrite the paths.
|
||||
|
||||
::
|
||||
|
||||
mmctl config subpath [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
# you can rewrite the assets to use a subpath
|
||||
mmctl config subpath --assets-dir /opt/mattermost/client --path /mattermost
|
||||
|
||||
# the subpath can have multiple steps
|
||||
mmctl config subpath --assets-dir /opt/mattermost/client --path /my/custom/subpath
|
||||
|
||||
# or you can fallback to the root path passing /
|
||||
mmctl config subpath --assets-dir /opt/mattermost/client --path /
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-a, --assets-dir string directory of the Mattermost assets in the local filesystem
|
||||
-h, --help help for subpath
|
||||
-p, --path string path to update the assets with
|
||||
|
||||
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 config <mmctl_config.rst>`_ - Configuration
|
||||
|
||||
45
server/cmd/mmctl/docs/mmctl_docs.rst
Normal file
45
server/cmd/mmctl/docs/mmctl_docs.rst
Normal file
@@ -0,0 +1,45 @@
|
||||
.. _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
|
||||
|
||||
46
server/cmd/mmctl/docs/mmctl_export.rst
Normal file
46
server/cmd/mmctl/docs/mmctl_export.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
.. _mmctl_export:
|
||||
|
||||
mmctl export
|
||||
------------
|
||||
|
||||
Management of exports
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of exports
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for export
|
||||
|
||||
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
|
||||
* `mmctl export create <mmctl_export_create.rst>`_ - Create export file
|
||||
* `mmctl export delete <mmctl_export_delete.rst>`_ - Delete export file
|
||||
* `mmctl export download <mmctl_export_download.rst>`_ - Download export files
|
||||
* `mmctl export generate-presigned-url <mmctl_export_generate-presigned-url.rst>`_ - Generate a presigned url for an export file. This is helpful when an export is big and might have trouble downloading from the Mattermost server.
|
||||
* `mmctl export job <mmctl_export_job.rst>`_ - List, show and cancel export jobs
|
||||
* `mmctl export list <mmctl_export_list.rst>`_ - List export files
|
||||
|
||||
48
server/cmd/mmctl/docs/mmctl_export_create.rst
Normal file
48
server/cmd/mmctl/docs/mmctl_export_create.rst
Normal file
@@ -0,0 +1,48 @@
|
||||
.. _mmctl_export_create:
|
||||
|
||||
mmctl export create
|
||||
-------------------
|
||||
|
||||
Create export file
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Create export file
|
||||
|
||||
::
|
||||
|
||||
mmctl export create [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for create
|
||||
--include-archived-channels Include archived channels in the export file.
|
||||
--include-profile-pictures Include profile pictures in the export file.
|
||||
--no-attachments Exclude file attachments from the export file.
|
||||
--no-roles-and-schemes Exclude roles and custom permission schemes from the export file.
|
||||
|
||||
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 export <mmctl_export.rst>`_ - Management of exports
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_export_delete.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_export_delete.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_export_delete:
|
||||
|
||||
mmctl export delete
|
||||
-------------------
|
||||
|
||||
Delete export file
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Delete export file
|
||||
|
||||
::
|
||||
|
||||
mmctl export delete [exportname] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
export delete export_file.zip
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for delete
|
||||
|
||||
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 export <mmctl_export.rst>`_ - Management of exports
|
||||
|
||||
56
server/cmd/mmctl/docs/mmctl_export_download.rst
Normal file
56
server/cmd/mmctl/docs/mmctl_export_download.rst
Normal file
@@ -0,0 +1,56 @@
|
||||
.. _mmctl_export_download:
|
||||
|
||||
mmctl export download
|
||||
---------------------
|
||||
|
||||
Download export files
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Download export files
|
||||
|
||||
::
|
||||
|
||||
mmctl export download [exportname] [filepath] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
# you can indicate the name of the export and its destination path
|
||||
$ mmctl export download samplename sample_export.zip
|
||||
|
||||
# or if you only indicate the name, the path would match it
|
||||
$ mmctl export download sample_export.zip
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for download
|
||||
--num-retries int Number of retries to do to resume a download. (default 5)
|
||||
|
||||
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 export <mmctl_export.rst>`_ - Management of exports
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
.. _mmctl_export_generate-presigned-url:
|
||||
|
||||
mmctl export generate-presigned-url
|
||||
-----------------------------------
|
||||
|
||||
Generate a presigned url for an export file. This is helpful when an export is big and might have trouble downloading from the Mattermost server.
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Generate a presigned url for an export file. This is helpful when an export is big and might have trouble downloading from the Mattermost server.
|
||||
|
||||
::
|
||||
|
||||
mmctl export generate-presigned-url [exportname] [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for generate-presigned-url
|
||||
|
||||
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 export <mmctl_export.rst>`_ - Management of exports
|
||||
|
||||
43
server/cmd/mmctl/docs/mmctl_export_job.rst
Normal file
43
server/cmd/mmctl/docs/mmctl_export_job.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. _mmctl_export_job:
|
||||
|
||||
mmctl export job
|
||||
----------------
|
||||
|
||||
List, show and cancel export jobs
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List, show and cancel export jobs
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for job
|
||||
|
||||
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 export <mmctl_export.rst>`_ - Management of exports
|
||||
* `mmctl export job cancel <mmctl_export_job_cancel.rst>`_ - Cancel export job
|
||||
* `mmctl export job list <mmctl_export_job_list.rst>`_ - List export jobs
|
||||
* `mmctl export job show <mmctl_export_job_show.rst>`_ - Show export job
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_export_job_cancel.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_export_job_cancel.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_export_job_cancel:
|
||||
|
||||
mmctl export job cancel
|
||||
-----------------------
|
||||
|
||||
Cancel export job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Cancel export job
|
||||
|
||||
::
|
||||
|
||||
mmctl export job cancel [exportJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
export job cancel o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for cancel
|
||||
|
||||
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 export job <mmctl_export_job.rst>`_ - List, show and cancel export jobs
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_export_job_list.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_export_job_list.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_export_job_list:
|
||||
|
||||
mmctl export job list
|
||||
---------------------
|
||||
|
||||
List export jobs
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List export jobs
|
||||
|
||||
::
|
||||
|
||||
mmctl export job list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
export job list
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all Fetch all export jobs. --page flag will be ignore if provided
|
||||
-h, --help help for list
|
||||
--page int Page number to fetch for the list of export jobs
|
||||
--per-page int Number of export jobs to be fetched (default 200)
|
||||
|
||||
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 export job <mmctl_export_job.rst>`_ - List, show and cancel export jobs
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_export_job_show.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_export_job_show.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_export_job_show:
|
||||
|
||||
mmctl export job show
|
||||
---------------------
|
||||
|
||||
Show export job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show export job
|
||||
|
||||
::
|
||||
|
||||
mmctl export job show [exportJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
export job show o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for show
|
||||
|
||||
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 export job <mmctl_export_job.rst>`_ - List, show and cancel export jobs
|
||||
|
||||
44
server/cmd/mmctl/docs/mmctl_export_list.rst
Normal file
44
server/cmd/mmctl/docs/mmctl_export_list.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
.. _mmctl_export_list:
|
||||
|
||||
mmctl export list
|
||||
-----------------
|
||||
|
||||
List export files
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List export files
|
||||
|
||||
::
|
||||
|
||||
mmctl export list [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
|
||||
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 export <mmctl_export.rst>`_ - Management of exports
|
||||
|
||||
42
server/cmd/mmctl/docs/mmctl_extract.rst
Normal file
42
server/cmd/mmctl/docs/mmctl_extract.rst
Normal file
@@ -0,0 +1,42 @@
|
||||
.. _mmctl_extract:
|
||||
|
||||
mmctl extract
|
||||
-------------
|
||||
|
||||
Management of content extraction job.
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of content extraction job.
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for extract
|
||||
|
||||
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
|
||||
* `mmctl extract job <mmctl_extract_job.rst>`_ - List and show content extraction jobs
|
||||
* `mmctl extract run <mmctl_extract_run.rst>`_ - Start a content extraction job.
|
||||
|
||||
42
server/cmd/mmctl/docs/mmctl_extract_job.rst
Normal file
42
server/cmd/mmctl/docs/mmctl_extract_job.rst
Normal file
@@ -0,0 +1,42 @@
|
||||
.. _mmctl_extract_job:
|
||||
|
||||
mmctl extract job
|
||||
-----------------
|
||||
|
||||
List and show content extraction jobs
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List and show content extraction jobs
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for job
|
||||
|
||||
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 extract <mmctl_extract.rst>`_ - Management of content extraction job.
|
||||
* `mmctl extract job list <mmctl_extract_job_list.rst>`_ - List content extraction jobs
|
||||
* `mmctl extract job show <mmctl_extract_job_show.rst>`_ - Show extract job
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_extract_job_list.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_extract_job_list.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_extract_job_list:
|
||||
|
||||
mmctl extract job list
|
||||
----------------------
|
||||
|
||||
List content extraction jobs
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List content extraction jobs
|
||||
|
||||
::
|
||||
|
||||
mmctl extract job list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
extract job list
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all Fetch all extract jobs. --page flag will be ignore if provided
|
||||
-h, --help help for list
|
||||
--page int Page number to fetch for the list of extract jobs
|
||||
--per-page int Number of extract jobs to be fetched (default 200)
|
||||
|
||||
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 extract job <mmctl_extract_job.rst>`_ - List and show content extraction jobs
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_extract_job_show.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_extract_job_show.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_extract_job_show:
|
||||
|
||||
mmctl extract job show
|
||||
----------------------
|
||||
|
||||
Show extract job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show extract job
|
||||
|
||||
::
|
||||
|
||||
mmctl extract job show [extractJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
extract job show f3d68qkkm7n8xgsfxwuo498rah
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for show
|
||||
|
||||
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 extract job <mmctl_extract_job.rst>`_ - List and show content extraction jobs
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_extract_run.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_extract_run.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_extract_run:
|
||||
|
||||
mmctl extract run
|
||||
-----------------
|
||||
|
||||
Start a content extraction job.
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Start a content extraction job.
|
||||
|
||||
::
|
||||
|
||||
mmctl extract run [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
extract run
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--from int The timestamp of the earliest file to extract, expressed in seconds since the unix epoch.
|
||||
-h, --help help for run
|
||||
--to int The timestamp of the latest file to extract, expressed in seconds since the unix epoch. Defaults to the current time.
|
||||
|
||||
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 extract <mmctl_extract.rst>`_ - Management of content extraction job.
|
||||
|
||||
44
server/cmd/mmctl/docs/mmctl_group.rst
Normal file
44
server/cmd/mmctl/docs/mmctl_group.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
.. _mmctl_group:
|
||||
|
||||
mmctl group
|
||||
-----------
|
||||
|
||||
Management of groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of groups
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for group
|
||||
|
||||
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
|
||||
* `mmctl group channel <mmctl_group_channel.rst>`_ - Management of channel groups
|
||||
* `mmctl group list-ldap <mmctl_group_list-ldap.rst>`_ - List LDAP groups
|
||||
* `mmctl group team <mmctl_group_team.rst>`_ - Management of team groups
|
||||
* `mmctl group user <mmctl_group_user.rst>`_ - Management of custom user groups
|
||||
|
||||
44
server/cmd/mmctl/docs/mmctl_group_channel.rst
Normal file
44
server/cmd/mmctl/docs/mmctl_group_channel.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
.. _mmctl_group_channel:
|
||||
|
||||
mmctl group channel
|
||||
-------------------
|
||||
|
||||
Management of channel groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of channel groups
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for channel
|
||||
|
||||
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 group <mmctl_group.rst>`_ - Management of groups
|
||||
* `mmctl group channel disable <mmctl_group_channel_disable.rst>`_ - Disables group constrains in the specified channel
|
||||
* `mmctl group channel enable <mmctl_group_channel_enable.rst>`_ - Enables group constrains in the specified channel
|
||||
* `mmctl group channel list <mmctl_group_channel_list.rst>`_ - List channel groups
|
||||
* `mmctl group channel status <mmctl_group_channel_status.rst>`_ - Show's the group constrain status for the specified channel
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_channel_disable.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_channel_disable.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_channel_disable:
|
||||
|
||||
mmctl group channel disable
|
||||
---------------------------
|
||||
|
||||
Disables group constrains in the specified channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Disables group constrains in the specified channel
|
||||
|
||||
::
|
||||
|
||||
mmctl group channel disable [team]:[channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group channel disable myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for disable
|
||||
|
||||
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 group channel <mmctl_group_channel.rst>`_ - Management of channel groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_channel_enable.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_channel_enable.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_channel_enable:
|
||||
|
||||
mmctl group channel enable
|
||||
--------------------------
|
||||
|
||||
Enables group constrains in the specified channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Enables group constrains in the specified channel
|
||||
|
||||
::
|
||||
|
||||
mmctl group channel enable [team]:[channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group channel enable myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for enable
|
||||
|
||||
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 group channel <mmctl_group_channel.rst>`_ - Management of channel groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_channel_list.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_channel_list.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_channel_list:
|
||||
|
||||
mmctl group channel list
|
||||
------------------------
|
||||
|
||||
List channel groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List the groups associated with a channel
|
||||
|
||||
::
|
||||
|
||||
mmctl group channel list [team]:[channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group channel list myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
|
||||
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 group channel <mmctl_group_channel.rst>`_ - Management of channel groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_channel_status.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_channel_status.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_channel_status:
|
||||
|
||||
mmctl group channel status
|
||||
--------------------------
|
||||
|
||||
Show's the group constrain status for the specified channel
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show's the group constrain status for the specified channel
|
||||
|
||||
::
|
||||
|
||||
mmctl group channel status [team]:[channel] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group channel status myteam:mychannel
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for status
|
||||
|
||||
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 group channel <mmctl_group_channel.rst>`_ - Management of channel groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_list-ldap.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_list-ldap.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_list-ldap:
|
||||
|
||||
mmctl group list-ldap
|
||||
---------------------
|
||||
|
||||
List LDAP groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List LDAP groups
|
||||
|
||||
::
|
||||
|
||||
mmctl group list-ldap [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group list-ldap
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list-ldap
|
||||
|
||||
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 group <mmctl_group.rst>`_ - Management of groups
|
||||
|
||||
44
server/cmd/mmctl/docs/mmctl_group_team.rst
Normal file
44
server/cmd/mmctl/docs/mmctl_group_team.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
.. _mmctl_group_team:
|
||||
|
||||
mmctl group team
|
||||
----------------
|
||||
|
||||
Management of team groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of team groups
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for team
|
||||
|
||||
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 group <mmctl_group.rst>`_ - Management of groups
|
||||
* `mmctl group team disable <mmctl_group_team_disable.rst>`_ - Disables group constrains in the specified team
|
||||
* `mmctl group team enable <mmctl_group_team_enable.rst>`_ - Enables group constrains in the specified team
|
||||
* `mmctl group team list <mmctl_group_team_list.rst>`_ - List team groups
|
||||
* `mmctl group team status <mmctl_group_team_status.rst>`_ - Show's the group constrain status for the specified team
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_team_disable.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_team_disable.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_team_disable:
|
||||
|
||||
mmctl group team disable
|
||||
------------------------
|
||||
|
||||
Disables group constrains in the specified team
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Disables group constrains in the specified team
|
||||
|
||||
::
|
||||
|
||||
mmctl group team disable [team] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group team disable myteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for disable
|
||||
|
||||
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 group team <mmctl_group_team.rst>`_ - Management of team groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_team_enable.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_team_enable.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_team_enable:
|
||||
|
||||
mmctl group team enable
|
||||
-----------------------
|
||||
|
||||
Enables group constrains in the specified team
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Enables group constrains in the specified team
|
||||
|
||||
::
|
||||
|
||||
mmctl group team enable [team] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group team enable myteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for enable
|
||||
|
||||
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 group team <mmctl_group_team.rst>`_ - Management of team groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_team_list.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_team_list.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_team_list:
|
||||
|
||||
mmctl group team list
|
||||
---------------------
|
||||
|
||||
List team groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List the groups associated with a team
|
||||
|
||||
::
|
||||
|
||||
mmctl group team list [team] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group team list myteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
|
||||
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 group team <mmctl_group_team.rst>`_ - Management of team groups
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_team_status.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_team_status.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_team_status:
|
||||
|
||||
mmctl group team status
|
||||
-----------------------
|
||||
|
||||
Show's the group constrain status for the specified team
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show's the group constrain status for the specified team
|
||||
|
||||
::
|
||||
|
||||
mmctl group team status [team] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group team status myteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for status
|
||||
|
||||
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 group team <mmctl_group_team.rst>`_ - Management of team groups
|
||||
|
||||
41
server/cmd/mmctl/docs/mmctl_group_user.rst
Normal file
41
server/cmd/mmctl/docs/mmctl_group_user.rst
Normal file
@@ -0,0 +1,41 @@
|
||||
.. _mmctl_group_user:
|
||||
|
||||
mmctl group user
|
||||
----------------
|
||||
|
||||
Management of custom user groups
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of custom user groups
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for user
|
||||
|
||||
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 group <mmctl_group.rst>`_ - Management of groups
|
||||
* `mmctl group user restore <mmctl_group_user_restore.rst>`_ - Restore user group
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_group_user_restore.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_group_user_restore.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_group_user_restore:
|
||||
|
||||
mmctl group user restore
|
||||
------------------------
|
||||
|
||||
Restore user group
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Restore deleted custom user group
|
||||
|
||||
::
|
||||
|
||||
mmctl group user restore [groupname] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
group user restore examplegroup
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for restore
|
||||
|
||||
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 group user <mmctl_group_user.rst>`_ - Management of custom user groups
|
||||
|
||||
46
server/cmd/mmctl/docs/mmctl_import.rst
Normal file
46
server/cmd/mmctl/docs/mmctl_import.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
.. _mmctl_import:
|
||||
|
||||
mmctl import
|
||||
------------
|
||||
|
||||
Management of imports
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Management of imports
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for import
|
||||
|
||||
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
|
||||
* `mmctl import delete <mmctl_import_delete.rst>`_ - Delete an import file
|
||||
* `mmctl import job <mmctl_import_job.rst>`_ - List and show import jobs
|
||||
* `mmctl import list <mmctl_import_list.rst>`_ - List import files
|
||||
* `mmctl import process <mmctl_import_process.rst>`_ - Start an import job
|
||||
* `mmctl import upload <mmctl_import_upload.rst>`_ - Upload import files
|
||||
* `mmctl import validate <mmctl_import_validate.rst>`_ - Validate an import file
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_import_delete.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_import_delete.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_import_delete:
|
||||
|
||||
mmctl import delete
|
||||
-------------------
|
||||
|
||||
Delete an import file
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Delete an import file
|
||||
|
||||
::
|
||||
|
||||
mmctl import delete [importname] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import delete import_file.zip
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for delete
|
||||
|
||||
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 import <mmctl_import.rst>`_ - Management of imports
|
||||
|
||||
42
server/cmd/mmctl/docs/mmctl_import_job.rst
Normal file
42
server/cmd/mmctl/docs/mmctl_import_job.rst
Normal file
@@ -0,0 +1,42 @@
|
||||
.. _mmctl_import_job:
|
||||
|
||||
mmctl import job
|
||||
----------------
|
||||
|
||||
List and show import jobs
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List and show import jobs
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for job
|
||||
|
||||
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 import <mmctl_import.rst>`_ - Management of imports
|
||||
* `mmctl import job list <mmctl_import_job_list.rst>`_ - List import jobs
|
||||
* `mmctl import job show <mmctl_import_job_show.rst>`_ - Show import job
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_import_job_list.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_import_job_list.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_import_job_list:
|
||||
|
||||
mmctl import job list
|
||||
---------------------
|
||||
|
||||
List import jobs
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List import jobs
|
||||
|
||||
::
|
||||
|
||||
mmctl import job list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import job list
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--all Fetch all import jobs. --page flag will be ignore if provided
|
||||
-h, --help help for list
|
||||
--page int Page number to fetch for the list of import jobs
|
||||
--per-page int Number of import jobs to be fetched (default 200)
|
||||
|
||||
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 import job <mmctl_import_job.rst>`_ - List and show import jobs
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_import_job_show.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_import_job_show.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_import_job_show:
|
||||
|
||||
mmctl import job show
|
||||
---------------------
|
||||
|
||||
Show import job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Show import job
|
||||
|
||||
::
|
||||
|
||||
mmctl import job show [importJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import job show f3d68qkkm7n8xgsfxwuo498rah
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for show
|
||||
|
||||
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 import job <mmctl_import_job.rst>`_ - List and show import jobs
|
||||
|
||||
49
server/cmd/mmctl/docs/mmctl_import_list.rst
Normal file
49
server/cmd/mmctl/docs/mmctl_import_list.rst
Normal file
@@ -0,0 +1,49 @@
|
||||
.. _mmctl_import_list:
|
||||
|
||||
mmctl import list
|
||||
-----------------
|
||||
|
||||
List import files
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List import files
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import list
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for list
|
||||
|
||||
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 import <mmctl_import.rst>`_ - Management of imports
|
||||
* `mmctl import list available <mmctl_import_list_available.rst>`_ - List available import files
|
||||
* `mmctl import list incomplete <mmctl_import_list_incomplete.rst>`_ - List incomplete import files uploads
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_import_list_available.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_import_list_available.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_import_list_available:
|
||||
|
||||
mmctl import list available
|
||||
---------------------------
|
||||
|
||||
List available import files
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List available import files
|
||||
|
||||
::
|
||||
|
||||
mmctl import list available [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import list available
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for available
|
||||
|
||||
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 import list <mmctl_import_list.rst>`_ - List import files
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_import_list_incomplete.rst
Normal file
51
server/cmd/mmctl/docs/mmctl_import_list_incomplete.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_import_list_incomplete:
|
||||
|
||||
mmctl import list incomplete
|
||||
----------------------------
|
||||
|
||||
List incomplete import files uploads
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List incomplete import files uploads
|
||||
|
||||
::
|
||||
|
||||
mmctl import list incomplete [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import list incomplete
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for incomplete
|
||||
|
||||
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 import list <mmctl_import_list.rst>`_ - List import files
|
||||
|
||||
54
server/cmd/mmctl/docs/mmctl_import_process.rst
Normal file
54
server/cmd/mmctl/docs/mmctl_import_process.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _mmctl_import_process:
|
||||
|
||||
mmctl import process
|
||||
--------------------
|
||||
|
||||
Start an import job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Start an import job
|
||||
|
||||
::
|
||||
|
||||
mmctl import process [importname] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import process 35uy6cwrqfnhdx3genrhqqznxc_import.zip
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--bypass-upload If this is set, the file is not processed from the server, but rather directly read from the filesystem. Works only in --local mode.
|
||||
--extract-content If this is set, document attachments will be extracted and indexed during the import process. It is advised to disable it to improve performance. (default true)
|
||||
-h, --help help for process
|
||||
--workers int The number of concurrent import worker goroutines. Controls database load during import. When set to 0 (default), uses the number of CPUs available. Maximum allowed is 4x the CPU count.
|
||||
|
||||
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 import <mmctl_import.rst>`_ - Management of imports
|
||||
|
||||
53
server/cmd/mmctl/docs/mmctl_import_upload.rst
Normal file
53
server/cmd/mmctl/docs/mmctl_import_upload.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
.. _mmctl_import_upload:
|
||||
|
||||
mmctl import upload
|
||||
-------------------
|
||||
|
||||
Upload import files
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Upload import files
|
||||
|
||||
::
|
||||
|
||||
mmctl import upload [filepath] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import upload import_file.zip
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for upload
|
||||
--resume Set to true to resume an incomplete import upload.
|
||||
--upload string The ID of the import upload to resume.
|
||||
|
||||
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 import <mmctl_import.rst>`_ - Management of imports
|
||||
|
||||
55
server/cmd/mmctl/docs/mmctl_import_validate.rst
Normal file
55
server/cmd/mmctl/docs/mmctl_import_validate.rst
Normal file
@@ -0,0 +1,55 @@
|
||||
.. _mmctl_import_validate:
|
||||
|
||||
mmctl import validate
|
||||
---------------------
|
||||
|
||||
Validate an import file
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Validate an import file
|
||||
|
||||
::
|
||||
|
||||
mmctl import validate [filepath] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
import validate import_file.zip --team myteam --team myotherteam
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--check-missing-teams Check for teams that are not defined but referenced in the archive
|
||||
--check-server-duplicates Set to false to ignore teams, channels, and users already present on the server (default true)
|
||||
-h, --help help for validate
|
||||
--ignore-attachments Don't check if the attached files are present in the archive
|
||||
--team stringArray Predefined team[s] to assume as already present on the destination server. Implies --check-missing-teams. The flag can be repeated
|
||||
|
||||
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 import <mmctl_import.rst>`_ - Management of imports
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user