97 lines
3.1 KiB
Markdown
Raw Normal View History

2016-09-11 17:55:19 +02:00
Slack-Term
==========
2016-10-02 16:07:35 +02:00
2016-10-22 09:41:35 +02:00
A [Slack](https://slack.com) client for your terminal.
2016-10-02 16:07:35 +02:00
2016-10-15 23:07:24 +02:00
![Screenshot](/screenshot.png?raw=true)
2016-10-02 16:07:35 +02:00
2016-10-15 23:07:24 +02:00
Getting started
---------------
2016-10-11 19:28:37 +02:00
2016-10-15 23:07:24 +02:00
1. [Download](https://github.com/erroneousboat/slack-term/releases) a
compatible version for your system, and place where you can access it from
2016-10-22 09:41:35 +02:00
the command line like, `~/bin`, `/usr/local/bin`, or `/usr/local/sbin`. Or
get it via Go:
```bash
2016-10-27 08:50:14 +01:00
$ go get github.com/erroneousboat/slack-term
2016-10-22 09:41:35 +02:00
```
2016-10-02 16:07:35 +02:00
2016-10-15 23:07:24 +02:00
2. Get a slack token, click [here](https://api.slack.com/docs/oauth-test-tokens)
2016-10-02 16:07:35 +02:00
2016-10-15 23:07:24 +02:00
3. Create a `slack-term.json` file, place it in your home directory. The file
should resemble the following structure:
```javascript
{
"slack_token": "yourslacktokenhere",
2016-10-15 23:07:24 +02:00
// optional: add the following to use light theme, default is dark
"theme": "light",
// optional: set the width of the sidebar (between 1 and 11), default is 1
"sidebar_width": 3,
// optional: define custom key mappings
// (shown are the default key mappings)
2016-10-30 14:26:12 +01:00
"key_map": {
2016-10-29 17:57:58 +02:00
"command": {
"i": "mode-insert",
"k": "channel-up",
"j": "channel-down",
"g": "channel-top",
"G": "channel-bottom",
"<previous>": "chat-up",
"C-b": "chat-up",
"C-u": "chat-up",
"<next>": "chat-down",
"C-f": "chat-down",
"C-d": "chat-down",
"q": "quit",
},
"insert": {
"<left>": "cursor-left",
"<right>": "cursor-right",
"<enter>": "send",
"<escape>": "mode-command",
"<backspace>": "backspace",
"<delete>": "delete",
"<space>": "space",
}
}
2016-10-15 23:07:24 +02:00
}
```
4. Run `slack-term`:
```bash
$ slack-term
// or specify the location of the config file
$ slack-term -config [path-to-config-file]
```
2016-10-02 16:07:35 +02:00
Default Key Mapping
-------------------
2016-10-02 16:07:35 +02:00
2016-10-30 14:26:12 +01:00
| mode | key | action |
|---------|-----------|----------------------------|
| command | `i` | insert 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 | `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 | `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 |