https://github.com/thehandsomepanther/slag
slack in the terminal using javascript
https://github.com/thehandsomepanther/slag
cli slack
Last synced: about 1 year ago
JSON representation
slack in the terminal using javascript
- Host: GitHub
- URL: https://github.com/thehandsomepanther/slag
- Owner: thehandsomepanther
- License: mit
- Created: 2016-12-25T21:44:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T03:16:52.000Z (over 8 years ago)
- Last Synced: 2025-04-14T11:15:07.046Z (about 1 year ago)
- Topics: cli, slack
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/slag-cli
- Size: 309 KB
- Stars: 16
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# slack terminal client
use slack in your terminal with an ncurses-style text-based gui.
## what this client supports right now
- chatting (public channels, private channels, DMs, etc)
- slash-commands from slack's hidden api!!
- @- and #-mentions
- emoji 🙌🏽
## what this client doesn't support/has trouble supporting (as of right now)
- images/gifs (for obvious reasons)
- files and links (they get printed out, but if they're too long they can go off the screen)
## how to run:
if you want to be able to run it from anywhere, make sure you have npm installed and run
```
npm install -g slag-cli
```
you'll need tokens for each team you'd like to use in slag. You can generate tokens for your team [here](https://api.slack.com/docs/oauth-test-tokens)
to register a token with slag, type
```
slag --add-token --team
```
if you'd like to add multiple teams at once, you can simply make your own json file and type
```
slag --set-tokens
```
if you choose to set your json manually, it should be structured like this:
```
[
{
"team": "ATEAM",
"token": "xoxp-***"
},
{
"team": "ANOTHER_TEAM",
"token": "xoxp-***"
}
]
```
once you've registered at least one token, you should be able to run slag from anywhere (assuming you've installed it globally) in your command line by typing:
```
slag
```
## how to use
|Key |Action|
|--- |--- |
|Tab |Switch between channel selection, message box, and team selection|
|Ctrl+T|Cycle through teams|
|Ctrl+C|Quit|
|Esc |Quit|
## how to contribute
clone this repo, then from inside the project directory run
```
npm install
```
and have at it. do the tokens thing too though.
## notes:
this project uses a json file generated by [jollygoodcode's emoji-keywords](https://github.com/jollygoodcode/emoji-keywords) to translate slack's `:emoji-code:` into unicode under the MIT license
## license
idk i guess we use the [MIT license](/license)