erroneousboat-slack-term/README.md

46 lines
1.2 KiB
Markdown
Raw Normal View History

2016-09-11 17:55:19 +02:00
Slack-Term
==========
2016-10-02 16:07:35 +02:00
A [Slack](https://slack.com) client for your terminal.
*This project is still in development*, but you can test it by downloading one
of the binaries for your system from the `bin` folder. Rename the file for
convenience into `slack-term` and create a `slack-term.json` file with
the following contents in your home folder.
2016-10-11 19:28:37 +02:00
```javascript
2016-10-02 16:07:35 +02:00
{
"slack_token": "yourslacktokenhere"
2016-10-11 19:28:37 +02:00
// add the following to use light theme, default is dark
"theme": "light"
2016-10-02 16:07:35 +02:00
}
```
Run `slack-term`:
```bash
$ ./slack-term
```
Usage
-----
| key | action |
|-----------|--------------------------|
| `i` | insert mode |
| `left` | move input cursor left |
| `right` | move input cursor right |
| `esc` | normal mode |
| `k` | move channel cursor up |
| `j` | move channel cursor down |
2016-10-09 18:37:00 +02:00
| `pg-up` | scroll chat pane up |
| `ctrl-b` | scroll chat pane up |
| `ctrl-u` | scroll chat pane up |
| `pg-down` | scroll chat pane down |
| `ctrl-f` | scroll chat pane down |
| `ctrl-d` | scroll chat pane down |
| `pg-down` | scroll chat pane down |
2016-10-02 16:07:35 +02:00
| `q` | quit |