Skip to content
Slack client for your terminal
Go Makefile Dockerfile
Branch: master
Clone or download

README.md

slack-term

A Slack client for your terminal.

Screenshot

Installation

Binary installation

Download a compatible binary for your system. For convenience, place slack-term in a directory where you can access it from the command line. Usually this is /usr/local/bin.

$ mv slack-term /usr/local/bin

Via Go

If you want, you can also get slack-term via Go:

$ go get -u github.com/erroneousboat/slack-term
$ cd $GOPATH/src/github.com/erroneousboat/slack-term
$ go install .

Via docker

You can also run it with docker, make sure you have a valid config file on your host system.

docker run -it -v [config-file]:/config erroneousboat/slack-term

Setup

  1. Get a slack token, click here

  2. Running slack-term for the first time, will create a default config file at ~/.config/slack-term/config.

$ slack-term
  1. Update the config file and update your slack_token For more configuration options of the config file, see the wiki.
{
    "slack_token": "yourslacktokenhere"
}

Usage

When everything is setup correctly you can run slack-term with the following command:

$ slack-term

Default Key Mapping

Below are the default key-mappings for slack-term, you can change them in your config file.

mode key action
command i insert mode
command / search mode
command k move channel cursor up
command j move channel cursor down
command g move channel cursor top
command G move channel cursor bottom
command K thread up
command J thread down
command G move channel cursor bottom
command pg-up scroll chat pane up
command ctrl-b scroll chat pane up
command ctrl-u scroll chat pane up
command pg-down scroll chat pane down
command ctrl-f scroll chat pane down
command ctrl-d scroll chat pane down
command n next search match
command N previous search match
command , jump to next notification
command q quit
command f1 help
insert left move input cursor left
insert right move input cursor right
insert enter send message
insert esc command mode
search esc command mode
search enter command mode
You can’t perform that action at this time.