https://github.com/1egoman/slick

A modular and extendable slack client.
https://github.com/1egoman/slick

Last synced: about 1 month ago
JSON representation

A modular and extendable slack client.

• Host: GitHub
• URL: https://github.com/1egoman/slick
• Owner: 1egoman
• License: mit
• Created: 2017-04-24T12:08:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-31T21:07:11.000Z (over 7 years ago)
• Last Synced: 2024-06-20T13:36:18.741Z (6 months ago)
• Language: Go
• Homepage:
• Size: 52.5 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Slick

Slick is a modular and extendable [slack](//slack.com) client with a terminal based ui, while also

aiming to be simple and intuitive. It has been designed to have an approachable default

configuration but to be easily extended with [lua](//lua.org).

[![CircleCI](https://img.shields.io/circleci/project/github/1egoman/slick.svg)](https://circleci.com/gh/1egoman/slick)

![license](https://img.shields.io/github/license/1egoman/slick.svg)

[](https://github.com/1egoman/slick/raw/master/docs/gifs/Monokai.png)

# Installing

1. Download a release from the releases page [here](https://github.com/1egoman/slick/releases).

2. Make slick executable: `chmod 775 slick*`

3. Move slick into your path: `mv slick* /usr/local/bin/slick`

4. Start slick: `slick`

[Read more](docs/Installing.md).

## Features

- **Modal** - Slick borrows a text based, [modal](docs/Modal.md) workflow from vi. Most

  functionality requires one keypress, or [can be easily mapped to a key](docs/Scripting.md).

- **Scriptable** - Add new commands (ie, `/foo`) or keyboard bindings (ie, press `a`) and bind

  them to slick commands. Or, write your own functionality in [Lua](//lua.org) - for example,

  [here's a plugin](examples/encrypt.lua) to encrypt a message to a user on keybase and send it to

  them via slack. [Learn More](docs/Scripting.md)

- **Batteries Included** - Distributed as a static binary with no dependencies.

  [Installation](docs/Installing.md) is simple. Slick is [updated automatically](docs/AutoUpdate.md)

  on start.

- **Not built on electron** - Slick is terminal based. Reduce the number of bloated [chrome

  vms](https://josephg.com/blog/electron-is-flash-for-the-desktop/) running on your system.

And a bunch of smaller things:

- Quick jump to another team / channel with `p`

- Multiple teams

- Tab completion for file paths

- A lua [standard library](https://github.com/1egoman/slick/blob/master/docs/Scripting.md#modules)

- Emoji support

- Extensive theming support - ie, [here](https://github.com/1egoman/slick/blob/master/docs/configuration/Message.Part.ChannelColor.md) [are](https://github.com/1egoman/slick/blob/master/docs/configuration/Message.Attachment.FieldValueColor.md) [a few](https://github.com/1egoman/slick/blob/master/docs/configuration/StatusBar.LogColor.md) [examples](https://github.com/1egoman/slick/blob/master/docs/configuration/StatusBar.GatewayConnectingColor.md)