Go to file
2020-05-05 09:17:29 +02:00
.github Update issue template 2019-09-21 13:42:16 +02:00
components Import lithammer/fuzzysearch instead of renstrom/fuzzysearch 2020-01-08 10:59:44 +01:00
config Add xdg configuration support 2020-01-08 11:39:16 +01:00
context Fix initial loading of threads 2019-09-14 12:34:53 +02:00
handlers Update nlopes/slack to slack-go/slack 2020-03-28 08:46:26 +01:00
service Update nlopes/slack to slack-go/slack 2020-03-28 08:46:26 +01:00
vendor Update nlopes/slack to slack-go/slack 2020-03-28 08:46:26 +01:00
views Fix initial loading of threads 2019-09-14 12:34:53 +02:00
.gitignore Update .gitignore to add vendor folder to project 2017-08-26 10:50:39 +02:00
CONTRIBUTING.md Add CONTRIBUTING.md 2018-10-27 17:13:07 +02:00
Dockerfile Update running with docker 2020-03-14 11:31:53 +01:00
go.mod Update nlopes/slack to slack-go/slack 2020-03-28 08:46:26 +01:00
go.sum Update nlopes/slack to slack-go/slack 2020-03-28 08:46:26 +01:00
LICENSE Make project public 2016-10-02 16:08:59 +02:00
main.go Add xdg configuration support 2020-01-08 11:39:16 +01:00
Makefile Add modules command 2020-01-08 11:39:16 +01:00
README.md Update readme 2020-05-05 09:17:29 +02:00
screenshot.png Update screenshot 2018-10-27 15:24:45 +02:00

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