README.md
1slack-term
2==========
3
4A [Slack](https://slack.com) client for your terminal.
5
6
7
8Installation
9------------
10
11#### Binary installation
12
13[Download](https://github.com/erroneousboat/slack-term/releases) a
14compatible binary for your system. For convenience, place `slack-term` in a
15directory where you can access it from the command line. Usually this is
16`/usr/local/bin`.
17
18```bash
19$ mv slack-term /usr/local/bin
20```
21
22#### Via Go
23
24If you want, you can also get `slack-term` via Go:
25
26```bash
27$ go get -u github.com/erroneousboat/slack-term
28$ cd $GOPATH/src/github.com/erroneousboat/slack-term
29$ go install .
30```
31
32Setup
33-----
34
351. Get a slack token, click [here](https://api.slack.com/docs/oauth-test-tokens)
36
372. Create a `.slack-term` file, and place it in your home directory. Below is
38 an example of such a file. You are only required to specify a
39 `slack_token`. For more configuration options of the `.slack-term` file,
40 see the [wiki](https://github.com/erroneousboat/slack-term/wiki).
41
42```javascript
43{
44 "slack_token": "yourslacktokenhere"
45}
46```
47
48Usage
49-----
50
51When everything is setup correctly you can run `slack-term` with the following
52command:
53
54```bash
55$ slack-term
56```
57
58Default Key Mapping
59-------------------
60
61Below are the default key-mappings for `slack-term`, you can change them
62in your `.slack-term` file.
63
64| mode | key | action |
65|---------|-----------|----------------------------|
66| command | `i` | insert mode |
67| command | `/` | search mode |
68| command | `k` | move channel cursor up |
69| command | `j` | move channel cursor down |
70| command | `g` | move channel cursor top |
71| command | `G` | move channel cursor bottom |
72| command | `pg-up` | scroll chat pane up |
73| command | `ctrl-b` | scroll chat pane up |
74| command | `ctrl-u` | scroll chat pane up |
75| command | `pg-down` | scroll chat pane down |
76| command | `ctrl-f` | scroll chat pane down |
77| command | `ctrl-d` | scroll chat pane down |
78| command | `n` | next search match |
79| command | `N` | previous search match |
80| command | `q` | quit |
81| command | `f1` | help |
82| insert | `left` | move input cursor left |
83| insert | `right` | move input cursor right |
84| insert | `enter` | send message |
85| insert | `esc` | command mode |
86| search | `esc` | command mode |
87| search | `enter` | command mode |
88
