Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The simplest library to say something on IRC.

branch: master
README.org

https://secure.travis-ci.org/portertech/carrier-pigeon.png

Install

gem install carrier-pigeon

Usage

require "carrier-pigeon"

Send a private message

CarrierPigeon.send(
  :uri => "irc://nick:password@irc.domain.com:6667/#channel",
  :message => "cooooo, coo coo"
)

Send a notice

CarrierPigeon.send(
  :uri => "irc://nick:password@irc.domain.com:6667/#channel",
  :message => "cooooo, coo coo",
  :notice => true
)

Use SSL

CarrierPigeon.send(
  :uri => "irc://nick:password@irc.domain.com:6667/#channel",
  :message => "coo, secret plan",
  :ssl => true
)

Join a channel (required for most Freenode channels)

CarrierPigeon.send(
  :uri => "irc://nick:password@irc.domain.com:6667/#channel",
  :message => "cooooo, part of the flock",
  :join => true
)

Join a channel that requires a password

CarrierPigeon.send(
  :uri => "irc://nick:password@irc.domain.com:6667/#channel",
  :message => "coo, the password is ..."
  :channel_password => "secret",
  :join => true
)

Identify with NickServ

CarrierPigeon.send(
  :uri => "irc://nick:password@irc.domain.com:6667/#channel",
  :message => "nickserv, coo coo",
  :nickserv_password => "secret"
)
Something went wrong with that request. Please try again.