Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukaszkorecki/ircnotify
Send notifications to your IRC server and/or channel of choice
https://github.com/lukaszkorecki/ircnotify
Last synced: 14 days ago
JSON representation
Send notifications to your IRC server and/or channel of choice
- Host: GitHub
- URL: https://github.com/lukaszkorecki/ircnotify
- Owner: lukaszkorecki
- License: mit
- Created: 2012-10-09T10:15:05.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2012-11-06T20:29:37.000Z (almost 12 years ago)
- Last Synced: 2024-04-25T10:21:46.837Z (7 months ago)
- Language: Ruby
- Size: 117 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Ircnotify
Simple tool for sending messages to IRC.
`ircnotify` can be used for:
- notifying when Chef has finished creating a new VM
- new code has been pushed to production and your apps are running
- you're compiling something and want to get notified when it's finished
- possibly more
Simply:
- create a config (take a look at `example_conf.yml`)
- install `ircnotify`
- send your message: `$ ircnotify -m "task finished!"`
- done
## 1000 words and oneliner
```
$ ircnotify -m "yooooooo"
```
## Example configuration
```yaml
nick: notifier
server: your.irc.com
port: 6667
password: 's4kr1t'
ssl:
use: true
verify: false
channels:
- '#test'
- '#test2'
```
`ircnotify` is based on [Cinch](https://github.com/cinchrb/cinch) and makes use of
some of config options, but not all. They are trivial to add though.
By default `ircnofity` reads the config from `~/.ircnotify`
## Usage
```
Usage:
ircnotifier --message "your message"
Options:
--config, -c : Config file (default: /Users/lukasz/.ircnotify)
--message, -m : Your message (default: test)
--verbose, -v: Be very verbose (default off)
--help, -h: Show this message
```
## Installation
```
$ gem install ircnotify
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request