2016-09-11 17:55:19 +02:00
|
|
|
Slack-Term
|
|
|
|
|
==========
|
2016-10-02 16:07:35 +02:00
|
|
|
|
2016-10-15 23:07:24 +02:00
|
|
|
A [Slack](https://slack.com) client for your terminal. As of now the
|
|
|
|
|
application is in a beta state. See [issues](https://github.com/erroneousboat/slack-term/issues)
|
|
|
|
|
for known bugs and for features I'm working on at the moment
|
2016-10-02 16:07:35 +02:00
|
|
|
|
2016-10-15 23:07:24 +02:00
|
|
|
|
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
|
|
|
|
|
the command line like, `~/bin`, `/usr/local/bin`, or `/usr/local/sbin`.
|
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
|
|
|
|
|
{
|
2016-10-18 17:55:37 +02:00
|
|
|
"slack_token": "yourslacktokenhere",
|
2016-10-15 23:07:24 +02:00
|
|
|
|
|
|
|
|
// add the following to use light theme, default is dark
|
|
|
|
|
"theme": "light"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
2016-10-15 23:07:24 +02:00
|
|
|
| mode | key | action |
|
|
|
|
|
|--------|-----------|--------------------------|
|
|
|
|
|
| normal | `i` | insert mode |
|
|
|
|
|
| normal | `k` | move channel cursor up |
|
|
|
|
|
| normal | `j` | move channel cursor down |
|
|
|
|
|
| normal | `pg-up` | scroll chat pane up |
|
|
|
|
|
| normal | `ctrl-b` | scroll chat pane up |
|
|
|
|
|
| normal | `ctrl-u` | scroll chat pane up |
|
|
|
|
|
| normal | `pg-down` | scroll chat pane down |
|
|
|
|
|
| normal | `ctrl-f` | scroll chat pane down |
|
|
|
|
|
| normal | `ctrl-d` | scroll chat pane down |
|
|
|
|
|
| normal | `pg-down` | scroll chat pane down |
|
|
|
|
|
| normal | `q` | quit |
|
|
|
|
|
| insert | `left` | move input cursor left |
|
|
|
|
|
| insert | `right` | move input cursor right |
|
|
|
|
|
| insert | `enter` | send message |
|
|
|
|
|
| insert | `esc` | normal mode |
|
