No description or website provided.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
ocelots.gemspec

README.md

Ocelots

Library and command line wrapper for ocelots api.

Installation

Add this line to your application's Gemfile:

gem 'ocelots'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ocelots

Usage

Set environment variable OCELOTS_AUTH_TOKEN with your auth token from ocelots.

Override the default url (http://ocelots.herokuapp.com) with your own instance by setting the OCELOTS_URL environment variable.

You should now be ready to roll:

Profile lookup

ocelots profile user@mail.com

This command performs an immediate lookup of a user's profile by their email address.

Chat shell

You can enter a very basic interactive antechamber (chat client) shell:

ocelots antechamber team_slug

IRC bot

You can also run an irc bot that will answer basic queries in a channel:

ocelots_bot ocelots irc.freenode.org 6667 '#channel'

At this stage, the bot will respond to a message to look up a phone number:

phone for user@mail.com

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