https://github.com/evanyeung/terminal-slack

Terminal client for slack
https://github.com/evanyeung/terminal-slack

javascript node slack terminal

Last synced: 3 days ago
JSON representation

Terminal client for slack

• Host: GitHub
• URL: https://github.com/evanyeung/terminal-slack
• Owner: evanyeung
• License: mit
• Created: 2015-05-10T00:14:25.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-16T07:29:39.000Z (almost 6 years ago)
• Last Synced: 2024-05-22T21:35:22.812Z (7 months ago)
• Topics: javascript, node, slack, terminal
• Language: JavaScript
• Size: 1.63 MB
• Stars: 1,032
• Watchers: 26
• Forks: 79
• Open Issues: 25
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terminal Slack

A terminal interface for Slack.

![Screenshot of Termianl Slack](screen-shot.png)

## Controls

| Command | Key Combination |

| ------- | --------------- |

| Move up | `up arrow` or `k` |

| Down up | `down arrow` or `j` |

| Search | `/` |

| Exit | `esc` |

| Select channels list | `ctrl` + `c` |

| Select users list | `ctrl` + `u` |

| Select writing area | `ctrl` + `w` |

| Select message list | `ctrl` + `l` |

 

## Prerequsites

 - [Node](https://nodejs.org/en/) v6.0.0 or higher

 - A [Slack](https://slack.com/) Account

## Setup

1. Download this repository:

	```

	git clone https://github.com/evanyeung/terminal-slack.git

	```

2. Enter the directory:

	```

	cd terminal-slack

	```

3. Install the package:

	```

	npm install

	```

	

4. Create your Legacy Slack API token.

	- Go to the [Slack Legacy Tokens](https://api.slack.com/custom-integrations/legacy-tokens) page

	- Click **Generate Token**

5. Install your token on your local machine, inserting your token between the quotes:

	```

	export SLACK_TOKEN='your-slack-token-here'

	```

6. Run the application: 

	```

	node main.js

	```

	

7. Terminal Slack should now launch.

## Troubleshooting

 - **Terminal Slack opens for a second but then closes again**

 	This might be due to your `SLACK_TOKEN` not being recognised. Make sure the put your `SLACK_TOKEN` between the two single quotes when exporting it:

 	

 	```

 	export SLACK_TOKEN='xoxp-254112160503-252950188691-252375361712-6cbf56aada30951a9d310a5f23d032a0'

 	```