A remote CLI tool for Mattermost: the Open Source, self-hosted Slack-alternative.
To install the project in your $GOPATH, simply run:
go get -u github.com/mattermost/mmctl
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)First we have to install the dependencies of the project. mmctl
depends on go version 1.13 or greater.
We can compile the binary with:
make buildFor 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:$ mmctl auth login https://community.mattermost.com --name community --username my-username --password mysupersecretThe 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 123456Instead 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
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent