A remote CLI tool for Mattermost: the Open Source, self-hosted Slack-alternative.
To install the project in your $GOPATH
, simply run:
go install github.com/mattermost/mmctl/v6@master
To install the shell completions for bash, add the following line to your ~/.bashrc
or ~/.profile
file:
source <(mmctl completion bash)
For zsh, add the following line to file ~/.zshrc
:
source <(mmctl completion zsh)
For the usage of all the commands, use the --help
flag or check the tool's documentation.
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
Usage:
mmctl [command]
Available Commands:
auth Manages the credentials of the remote Mattermost instances
channel Management of channels
completion Generates autocompletion scripts for bash and zsh
group Management of groups
help Help about any command
license Licensing commands
logs Display logs in a human-readable format
permissions Management of permissions and roles
plugin Management of plugins
post Management of posts
team Management of teams
user Management of users
websocket Display websocket in a human-readable format
Flags:
-h, --help help for mmctl
Use "mmctl [command] --help" for more information about a command.
First we have to log into a mattermost instance:
$ mmctl auth login https://my-instance.example.com --name my-instance --username john.doe --password mysupersecret
credentials for my-instance: john.doe@https://my-instance.example.com stored
We can check the currently stored credentials with:
$ mmctl auth list
| Active | Name | Username | InstanceUrl |
|--------|-------------|----------|---------------------------------|
| * | my-instance | john.doe | https://my-instance.example.com |
And now we can run commands normally:
$ mmctl user search john.doe
id: qykfw3t933y38k57ubct77iu9c
username: john.doe
nickname:
position:
first_name: John
last_name: Doe
email: [email protected]
auth_service:
NOTE: mmctl
is designed to run against a specific version of the mattermost-server
and its API. If run against a server with a different version, mmctl
will show a warning and will try to execute the commands. To ensure that the commands won't run if the server version is not supported, please use the --strict
flag or set the MMCTL_STRICT=true
environment variable.
$ mmctl auth login https://community.mattermost.com --name community --username my-username --password mysupersecret
The login
command can also work interactively, so if you leave any needed flag empty, mmctl
will ask you for it interactively:
$ mmctl auth login https://community.mattermost.com
Connection name: community
Username: my-username
Password:
If you want to login with MFA, you just need to use the --mfa-token
flag:
$ mmctl auth login https://community.mattermost.com --name community --username my-username --password mysupersecret --mfa-token 123456
Instead of using username and password to log in, you can generate and use a personal access token to authenticate with a server:
$ mmctl auth login https://community.mattermost.com --name community --access-token MY_ACCESS_TOKEN
First we have to install the dependencies of the project. mmctl
depends on go version 1.13.3 or greater.
We can compile the binary with:
make build
mmctl
has two types of tests: unit tests and end to end tests.
To run the unit tests, you just need to execute:
make test
To run the end to end test suite, you need to have the Mattermost server project downloaded and configured in your system. Check the Developer Setup guide on how to configure a local server instance. The tests will search for a mattermost-server
folder in the same directory where the mmctl
is, but this can be changed through configuration if you have the project in a different path. Take a look at the config.mk
file in this repository for instructions on how to make this change.
With the mattermost-server
folder present, the only thing that needs to be done before running the tests themselves is to start the Mattermost docker development environment. The environment only needs to be started once, and then the tests can run as many times as needed. To start the docker environment, change to the mattermost-server
project directory and run:
make start-docker
Change your directory back to mmctl
and run the end to end test suite with:
make test-e2e