mattermost-cli

Mattermost CLI for humans and agents.

Install

# Run directly (no install)
uvx --from mattermost-cli mm --help

# Or install globally
pip install mattermost-cli

Setup

# Interactive login (password + MFA)
mm login --url https://chat.example.com

# Or with a Personal Access Token
mm login --url https://chat.example.com --token <your-pat>

# Verify
mm whoami

Usage

# Get oriented (mentions + unread + active channels in one call)
mm overview

# Read messages
mm messages general
mm messages general --since 1h
mm messages general --threads       # thread index view
mm messages @alice                  # DM with a user

# Threads
mm thread <post-id>                 # root + last 9 replies
mm thread <post-id> --limit 0      # full thread

# Search and mentions
mm search "deployment issue"
mm mentions                         # @-mentions in last 24h

# Download files by file ID
mm download abc123def456ghi789jkl012
mm download abc123... def456... --output downloads/

# Channel info
mm channel general                  # purpose, members, pinned count
mm channels --since 6h              # recently active channels
mm unread                           # channels with unread messages
mm pinned general                   # pinned posts
mm members general                  # who's in the channel

# People
mm user @alice                      # profile, status, timezone

JSON Output

All commands output JSON by default. Key fields:

  • thread_id on every post - pass to mm thread
  • ref on channel entries - pass to mm messages
  • files[].id on posts with attachments - pass to mm download
  • is_bot / bot_name - webhook/bot posts flagged automatically
  • root on reply-mentions - the original message being replied to
  • reactions - emoji counts like {"+1": 3}

Webhook posts automatically extract alert content from Slack-format attachments.

Add --human for readable markdown output instead.

Agent Skill

Install as a coding agent skill:

npx skills add rhnvrm/mattermost-cli

Options

--human    Human-readable markdown output (default is JSON)
--team     Filter to a specific team
--debug    Enable debug output

Auth

Two methods supported:

Password + MFA (primary): mm login prompts interactively. Session token is stored locally - password is never saved to disk. When the session expires, run mm login again.

Personal Access Token (optional): mm login --token <pat>. Requires admin to enable PATs on the Mattermost server. Tokens don't expire.

Credentials stored at ~/.config/mm/config.json (token only, 600 permissions).

Environment variables override config: MATTERMOST_URL, MATTERMOST_TOKEN, MATTERMOST_TEAM.

License

MIT

Project links

Data verified by PyPI on Jun 29, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for rhnvrm from gravatar.com rhnvrm

Credits

Author: Rohan Verma

GitHub Statistics

Data verified by PyPI on Jun 29, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.9

Provides Extra

dev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mattermost_cli-0.0.4.tar.gz (40.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mattermost_cli-0.0.4-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file mattermost_cli-0.0.4.tar.gz.

File metadata

  • Download URL: mattermost_cli-0.0.4.tar.gz
  • Upload date:
  • Size: 40.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mattermost_cli-0.0.4.tar.gz
Algorithm Hash digest
SHA256 c6ebd0540f9e175c73c7b8a9a5db85fe017c2474d62c8326c974691afe7cd486
MD5 d8ebde0c44575f6ce58eaf181eb22f84
BLAKE2b-256 f56b403ec03717f23ca8183946fb5f9b4a7a224a59de73c91d58712c67382227

See more details on using hashes here.

Provenance

The following attestation bundles were made for mattermost_cli-0.0.4.tar.gz:

Publisher: publish.yml on rhnvrm/mattermost-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mattermost_cli-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: mattermost_cli-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mattermost_cli-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 026e491f1bb68043cca06936133c2ec87a17e4c5586e5e449d31de3d00c205d7
MD5 88a6710b38a4533b679826fd2b4b6796
BLAKE2b-256 b5ed65e9085be120ace81ef87b560a339f98142356cc5890228ae17cc1b5b09d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mattermost_cli-0.0.4-py3-none-any.whl:

Publisher: publish.yml on rhnvrm/mattermost-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page