mirrors/erroneousboat-slack-term
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
erroneousboat 2017-08-26 10:50:19 +02:00
parent c06d57a67c
commit 516b880e08
1 changed files with 89 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
README.md
View File

@ -5,87 +5,113 @@ A [Slack](https://slack.com) client for your terminal.
![Screenshot](/screenshot.png?raw=true) ![Screenshot](/screenshot.png?raw=true)
Getting started Installation
--------------- ------------
1. [Download](https://github.com/erroneousboat/slack-term/releases) a #### Binary installation
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`. Or
get it via Go:
[Download](https://github.com/erroneousboat/slack-term/releases) 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`.
```bash ```bash
$ go get -u github.com/erroneousboat/slack-term $ mv slack-term /usr/local/bin
``` ```
2. Get a slack token, click [here](https://api.slack.com/docs/oauth-test-tokens) #### Via Go
3. Create a `slack-term.json` file, place it in your home directory. The file If you want you can also get `slack-term` via Go:
should resemble the following structure (don't forget to remove the comments):
```javascript ```bash
{ $ go get -u github.com/erroneousboat/slack-term
"slack_token": "yourslacktokenhere", ```
// OPTIONAL: add the following to use light theme, default is dark Setup
"theme": "light", -----
// OPTIONAL: set the width of the sidebar (between 1 and 11), default is 1 1. Get a slack token, click [here](https://api.slack.com/docs/oauth-test-tokens)
"sidebar_width": 3,
// OPTIONAL: define custom key mappings, defaults are: 2. Create a `slack-term.json` file, place it in your home directory. Below is
"key_map": { an an example file, you can leave out the `OPTIONAL` parts, you are only
"command": { required to specify a `slack_token`. Remember that your file should be
"i": "mode-insert", a valid json file so don't forget to remove the comments.
"k": "channel-up",
"j": "channel-down", ```javascript
"g": "channel-top", {
"G": "channel-bottom", "slack_token": "yourslacktokenhere",
"<previous>": "chat-up",
"C-b": "chat-up", // OPTIONAL: add the following to use light theme, default is dark
"C-u": "chat-up", "theme": "light",
"<next>": "chat-down",
"C-f": "chat-down", // OPTIONAL: set the width of the sidebar (between 1 and 11), default is 1
"C-d": "chat-down", "sidebar_width": 3,
"q": "quit",
"<f1>": "help" // OPTIONAL: define custom key mappings, defaults are:
}, "key_map": {
"insert": { "command": {
"<left>": "cursor-left", "i": "mode-insert",
"<right>": "cursor-right", "k": "channel-up",
"<enter>": "send", "j": "channel-down",
"<escape>": "mode-command", "g": "channel-top",
"<backspace>": "backspace", "G": "channel-bottom",
"C-8": "backspace", "<previous>": "chat-up",
"<delete>": "delete", "C-b": "chat-up",
"<space>": "space" "C-u": "chat-up",
}, "<next>": "chat-down",
"search": { "C-f": "chat-down",
"<left>": "cursor-left", "C-d": "chat-down",
"<right>": "cursor-right", "q": "quit",
"<escape>": "clear-input", "<f1>": "help"
"<enter>": "clear-input", },
"<backspace>": "backspace", "insert": {
"C-8": "backspace", "<left>": "cursor-left",
"<delete>": "delete", "<right>": "cursor-right",
"<space>": "space" "<enter>": "send",
} "<escape>": "mode-command",
"<backspace>": "backspace",
"C-8": "backspace",
"<delete>": "delete",
"<space>": "space"
},
"search": {
"<left>": "cursor-left",
"<right>": "cursor-right",
"<escape>": "clear-input",
"<enter>": "clear-input",
"<backspace>": "backspace",
"C-8": "backspace",
"<delete>": "delete",
"<space>": "space"
} }
} }
``` }
```
4. Run `slack-term`: Usage
-----
```bash When everything is setup correctly you can run `slack-term` with the following
$ slack-term command:
// or specify the location of the config file ```bash
$ slack-term -config [path-to-config-file] $ slack-term
``` ```
You can also specify the location of the config file, this will give you
the possibility to run several instances of `slack-term` with different
accounts.
```bash
$ slack-term -config [path-to-config-file]
```
Default Key Mapping Default Key Mapping
------------------- -------------------
Below are the default key-mapping for `slack-term`, you can change them
in your `slack-term.json` file.
| mode | key | action | | mode | key | action |
|---------|-----------|----------------------------| |---------|-----------|----------------------------|
| command | `i` | insert mode | | command | `i` | insert mode |