Help / Mattermost / Terminal client (Matterhorn)
Mattermost
Terminal client (Matterhorn)
Use lab chat from the command line — install and set up Matterhorn, a keyboard-driven terminal client for Mattermost.
Matterhorn (opens in new tab) is a full-screen terminal client for Mattermost — keyboard-driven and fast, with no Electron. It talks to the same server as the web and desktop apps, so your channels, DMs, threads, and reactions are all there. Good if you live in the shell.
Install on macOS
The Homebrew cask is deprecated (it trips macOS Gatekeeper), so grab the release build directly:
- Open the releases page (opens in new tab)
and copy the URL of the build for your Mac:
- Apple Silicon (M-series): the
…-Darwin-arm64.tar.bz2file - Intel: the
…-Darwin-x86_64.tar.bz2file
- Apple Silicon (M-series): the
- Download it with
curl— downloading in the terminal skips the macOS quarantine flag, so Gatekeeper won’t block it (the binary is ad-hoc signed):mkdir -p ~/scripts/matterhorn && cd ~/scripts/matterhorn curl -sSL -O "<paste the release URL>" tar xjf matterhorn-*.tar.bz2 - Put it on your
PATH(any directory already on your PATH works):ln -sf "$PWD"/matterhorn-*/matterhorn /opt/homebrew/bin/matterhorn # Apple Silicon # Intel Homebrew instead: /usr/local/bin/matterhorn
Install on Linux
The same releases page has prebuilt tarballs for Fedora and Ubuntu. Extract and
put the matterhorn binary on your PATH.
Configure
Create ~/.config/matterhorn/config.ini:
[mattermost]
user: your-username
host: <your lab chat server> # the address is in your invite email, or ask Francisco
port: 443
team: nuilab
Signing in: leave the password out and Matterhorn will prompt you at
launch. If you’d rather not be prompted, point passcmd (or tokencmd) at a
command that returns your password or a personal access token from a secret store
— for example the macOS keychain
(security find-generic-password -s matterhorn -w) or secret-tool on Linux.
Don’t hardcode a password in the file.
Launch
matterhorn
Inside, type /help for the full keybinding list and /quit to exit.
Keyboard cheat-sheet
Matterhorn is entirely keyboard-driven. The essentials:
| Do this | Keys |
|---|---|
| Next / previous channel | Ctrl-n / Ctrl-p |
| Next channel with unread | Alt-a |
| Jump to any channel/DM (fuzzy) | Ctrl-g → type a few letters → Enter |
| Scroll messages — one line | ↑ / ↓ |
| Scroll messages — one page | PgUp / PgDn |
| Oldest message | Shift-Home |
| Move within the sidebar list | Ctrl-↑ / Ctrl-↓ |
| Send a message | type, then Enter |
| Reply / react / open a link in a message | Ctrl-s to select a message, then r / a / o; Esc to exit |
| Full help (all keybindings) | F1 |
| Quit | Ctrl-q |
Tip: Ctrl-g is the fastest way around — press it, type part of a channel or person’s
name, and hit Enter.
Prefer your own IRC client?
matterircd (opens in new tab)
is a small bridge that makes
Mattermost look like an IRC server on localhost:6667, so you can use any IRC
client (WeeChat, irssi, …). It has no interface of its own — what you see is
your IRC client — so image-search results for it are a mix of Mattermost and IRC
screenshots, which can be confusing.
Documentation
Source: content/systems/mattermost/terminal-client.md · maintained in the lab docs repository.