Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hiroakis/twslacker

notify twitter stream to slack
https://github.com/hiroakis/twslacker

Last synced: 14 days ago
JSON representation

notify twitter stream to slack

Awesome Lists containing this project

README

        

# Twslacker

Notify slack of the twitter stream.

## Requirements

* Ruby
* Twitter tokens
* Slack incoming webhook URL

## Installation

```
git clone [email protected]:hiroakis/twslacker.git
cd twslacker
bundle install --path .bundle
```

## Usage

At first, create configration file `cp -p config.yml .config.yml`. Twslacker use `.config.yml` by default. Or you can use `-c` option to specify configuration file.

### start application

```
# sample: Random tweets in all over the world
bundle exec ruby bin/twslacker start --type sample

# track: Tweets that include specified keywords
bundle exec ruby bin/twslacker start --type track keyword keyword...

# follow: Tweets of specified twitter users
bundle exec ruby bin/twslacker start --type follow screen_name screen_name...

# userstream: Your timeline(default)
bundle exec ruby bin/twslacker start --type userstream
```

If you would like to ignore some words, you can use `--ignore` option.

* ignore tweet that includes "AAA", "BBB" or "CCC"

```
bundle exec ruby bin/twslacker start --type sample --ignore=AAA,BBB,CCC
```

* ignore Retweet, mention and hashtag

```
bundle exec ruby bin/twslacker start --type sample --ignore=RT,@,#
```

* daemonize

If you would like to start this application in daemon mode, use `-d` flag.

```
bundle exec ruby bin/twslacker start --type sample --ignore=AAA,BBB,CCC -d
```

### stop application

```
bundle exec ruby bin/twslacker stop
```

## TODO

test

## License

MIT