Lyle Hanson ce1d8ce03f Respect the XDG Base Directory specification for configs

Rather than assuming a configuration file at `~/.slack-term`, respect
the user's choice per the XDG Base Directory specification
(https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
to find the configuration.

Uses a cross-platform XDG library to abstract the details of the
specification and encompass any future changes
(https://github.com/OpenPeeDeeP/xdg, https://godoc.org/github.com/OpenPeeDeeP/xdg).

After merging, the [wiki home page](https://github.com/erroneousboat/slack-term/wiki)
should be updated to reflect the new configuration location.

This closes #170 and closes #203.

2020-01-08 11:39:16 +01:00

2.8 KiB

Raw Blame History

slack-term

A Slack client for your terminal.

Installation

Binary installation

Download 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.

$ mv slack-term /usr/local/bin

Via Go

If you want, you can also get slack-term via Go:

$ go get -u github.com/erroneousboat/slack-term
$ cd $GOPATH/src/github.com/erroneousboat/slack-term
$ go install .

Setup

Get a slack token, click here
Create a file named config in the $XDG_CONFIG_HOME/slack-term directory (the XDG Base Directory Specification specifies $HOME/.config/ if you do not have $XDG_CONFIG_HOME explicitly set). Below is an example of such a file. You are only required to specify a slack_token. For more configuration options of the config file, see the wiki.

{
    "slack_token": "yourslacktokenhere"
}

Usage

When everything is setup correctly you can run slack-term with the following command:

$ slack-term

Default Key Mapping

Below are the default key-mappings for slack-term, you can change them in your config file.

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	`n`	next search match
command	`N`	previous search match
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

2.8 KiB Raw Blame History