Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tadashi-aikawa/slackego

Ego search script for Slack.
https://github.com/tadashi-aikawa/slackego

Last synced: 25 days ago
JSON representation

Ego search script for Slack.

Awesome Lists containing this project

README

        

Slackego
========

Ego search script for Slack.

Requirements
------------

* Linux
* Mac (maybe)

Quick start
-----------

### Install

```
$ curl https://raw.githubusercontent.com/tadashi-aikawa/slackego/master/install.sh | sudo sh
```

### Create config

```
$ slackego init
```

### Set `SLACK_USER_TOKEN` and `SLACK_BOT_TOKEN`

Either `set a environmental variable` or `create .env`.

You should create a User OAuth Token with the below scopes.

- `SLACK_USER_TOKEN`
- `search:read`
- `SLACK_BOT_TOKEN`
- `chat:write`

### Check usage

```
$ slackego --help
Usage:
slackego run ... --minutes=
[--notify=]
[--config=]
[--forever]
slackego init

Options:
... Search words
--minutes= Since minutes before
--notify= Channel or direct message to notify (without #)
--config= Config file [default: config.json]
--forever Run forever
```

### Run

They are examples.

```
# Search for tadashi-aikawa.
$ slackego run tadashi-aikawa --minutes 60

# If you want to notify results to #times_tadashi-aikawa (slack channel)
$ slackego run tadashi-aikawa --minutes 60 --notify times_tadashi-aikawa
```

For developers
--------------

### Requirements

- Task

### Development

```console
task dev -- run want_to_search_message --minutes=60
```

### Release

```console
task release VERSION=1.2.3
```