Go to file

erroneousboat e3ca3b4621 Add custom eventstream for termui In order to fix issue #47 I've added a custom eventstream to termui that will deregister its own eventstream. This will ensure me that the events will not be sent to termui's (unbuffered) event channel and will be picked up by the buffered termbox channel of slack-term. Fixes #47		2017-07-15 15:57:59 +02:00
components	Add Channel topic next to channel name in chat window	2016-10-30 16:02:11 +01:00
config	Add secondary backspace to default config	2016-10-31 09:59:00 +01:00
context	Add EventQueue to AppContext	2017-03-17 14:43:08 +01:00
handlers	Add custom eventstream for termui	2017-07-15 15:57:59 +02:00
service	Fix some slack integrations	2016-10-31 21:26:12 +01:00
vendor	Update external packages	2017-03-17 14:43:08 +01: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	Add custom eventstream for termui	2017-07-15 15:57:59 +02:00
Makefile	Move authTest before creation of RTM	2016-10-21 14:05:36 +02:00
README.md	Fix README.md	2017-03-17 14:53:57 +01:00
screenshot.png	Make ready for beta release	2016-10-16 13:32:05 +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"
        }
    }
}

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	`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