A terminal client for the Mattermost chat system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jonathan Daugherty 628d97f834 Bump version, update changelog 3 years ago
logo Added icon+logo in SVG format as well as small PNG icons 4 years ago
screenshots Added screenshot of Matterhorn in action 3 years ago
scripts Add a figlet script 3 years ago
src yanking: handle Hclip exceptions gracefully (fixes #170) 3 years ago
.gitignore Ignore 'tags' as in 'hasktags' result file. 3 years ago
.travis.yml Make travis use new-build 4 years ago
CHANGELOG.md Bump version, update changelog 3 years ago
LICENSE Basic data structures in place for viewing 4 years ago
README.md Added screenshot of Matterhorn in action 3 years ago
RELEASES.md RELEASES: mention Github upload 3 years ago
Setup.hs add Setup.hs for cabal check 4 years ago
install.sh change URLs to use new matterhorn-chat github org 3 years ago
logo.png Move logo image into repository 4 years ago
matterhorn.cabal Bump version, update changelog 3 years ago
mkrelease.sh mkrelease: include the CHANGELOG 3 years ago
new-install.sh Fix Typo 3 years ago
sample-config.ini Make "port" config setting optional and default to 443 (fixes #160) 3 years ago

README.md

Build
Status

This is a basic terminal-based client for the MatterMost chat system.

Building

The easiest way to build it is to use the provided install.sh script, which requires git and an appropriate ghc/cabal installation. It will pull the appropriate repos and build the sandbox in the appropriate way.

If you want to, you can also run the install process manually. You’ll need both the matterhorn repo and the mattermost-api repo, neither of which are currently in Hackage. Clone both of them to an appropriate place:

$ git clone git@github.com:matterhorn-chat/mattermost-api.git
$ git clone git@github.com:matterhorn-chat/matterhorn.git

Move into the matterhorn directory, create a new sandbox, add the mattermost-api package as an extra dependency, install the dependencies, and build the package:

$ cd matterhorn
$ cabal sandbox init
$ cabal sandbox add-source ../mattermost-api
$ cabal install
$ cabal build

Configuring

Right now, configuration is manual. An example configuration file can be found at sample-config.ini. Matterhorn will prefer config.ini in the current working directory, but will look in the typical XDG configuration directories (you’ll probably want to use $HOME/.config/matterhorn/config.ini) and as a last resort look for a globally-accessible /etc/matterhorn/config.ini.

Using

You can often use built-in keybindings or /cmd-style commands. To see available keybindings and commands, press F1 or run the /help command.