Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivey/slack-tldr
Custom +tldr command for Slack to keep per-channel lists of notes
https://github.com/ivey/slack-tldr
Last synced: 8 days ago
JSON representation
Custom +tldr command for Slack to keep per-channel lists of notes
- Host: GitHub
- URL: https://github.com/ivey/slack-tldr
- Owner: ivey
- License: mit
- Created: 2016-10-11T23:02:18.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-16T05:54:46.000Z (about 8 years ago)
- Last Synced: 2024-08-02T16:44:00.484Z (3 months ago)
- Language: Go
- Homepage:
- Size: 59.6 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
slack-tldr [](https://travis-ci.org/ivey/slack-tldr)
==========
A Slack bot to provide easy access to pinned items inline in the chat.
Groups used to the hangupsbot built-in ```/bot tldr``` may find this
an useful tool to ease transition to Slack.
Installation
------------
1. Download the installation archive from [the releases tab](https://github.com/ivey/slack-tldr/releases).
2. Untar: ```tar xvfz slack-tldr.linux.amd64.tgz```
3. Create a Slack bot and copy the token.
4. Run it: ```./slack-tldr -token 'YOURSLACKTOKEN'```
5. Optional: use slack-tldr.service to keep it running under systemd
Usage
-----
Invite the bot to the channels you want it to be active in. Since it
stores items with pins in the channel, each channel has a separate
list.
If you just want to see the current pins, ```+tldr``` will trigger the
bot to display them.
You can create a new pin with ```+tldr Important thing to remember```.
You can delete a pinned item by getting the list from ```+tldr``` and
then ```+tldr remove 2``` where 2 is the number you want to delete.
Customization
-------------
If you'd rather use something other than ```+tldr``` as the command
string, the ```-command``` flag will allow you to change it.