Go to file

erroneousboat c88dff2cd2 Fix insert key When moving the cursor to to insert a new key. It was not correctly inserted at the right location. This fix will solve this.		2017-08-19 13:06:54 +02:00
components	Fix insert key	2017-08-19 13:06:54 +02:00
config	Add emoji support	2017-07-21 14:04:16 +02:00
context	Return terminal to normal when config file can't be found	2017-08-04 10:22:42 +02:00
handlers	Update event handlers	2017-07-30 15:23:47 +02:00
service	Update event handlers	2017-07-30 15:23:47 +02:00
vendor	Update vendor package versions	2017-08-05 11:43:50 +02:00
views	Add Channel topic next to channel name in chat window	2016-10-30 16:02:11 +01:00
.gitignore	Update project structure	2016-10-19 09:11:35 +02:00
LICENSE	Make project public	2016-10-02 16:08:59 +02:00
main.go	Update version number	2017-08-05 11:44:25 +02:00
Makefile	Move authTest before creation of RTM	2016-10-21 14:05:36 +02:00
README.md	Add search functionality	2017-07-16 14:43:02 +02:00
screenshot.png	Update screenshot	2017-07-30 15:33:18 +02:00

README.md

Slack-Term

A Slack client for your terminal.

Getting started

Download 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. Or get it via Go:
```
$ go get -u github.com/erroneousboat/slack-term
```
Get a slack token, click here

Create a slack-term.json file, place it in your home directory. The file should resemble the following structure (don't forget to remove the comments):

{
    "slack_token": "yourslacktokenhere",

    // 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, defaults are:
    "key_map": {
        "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",
            "<f1>":       "help"
        },
        "insert": {
            "<left>":      "cursor-left",
            "<right>":     "cursor-right",
            "<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"
        }
    }
}

Run slack-term:

$ slack-term

// or specify the location of the config file
$ slack-term -config [path-to-config-file]

Default Key Mapping

mode	key	action
command	`i`	insert mode
command	`/`	search 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
search	`esc`	command mode
search	`enter`	command mode