0.0
No commit activity in last 3 years
No release in over 3 years
A Ruby Command Line interface for the HipChat API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

A Ruby Command Line tool for the HipChat API

Currently provides a simple, easy to use command line tool for sending a message to a HipChat room. Similar to https://github.com/hipchat/hipchat-cli, but about a billion times more Ruby.

Installation

Install the gem:

gem install hipchat-cli

Sending A Message

Use the bin:

hipchat_notify --room [Room Name] --token [API TOKEN] Hello World!

or

echo "Hello World" | hipchat_notify --room [Room Name] --token [API TOKEN]

Options

-t, --token API_TOKEN            [required] The API token for HipChat
-r, --room ROOM                  [required] The room ID to receive the message
-u, --user USERNAME              The name of the sender. Default: API Client
-f, --format FORMAT              The format of the message. Default: html
-c, --color COLOR                message color: "red", "yellow", "green", "purple" or "random" (default "yellow")
-n, --notify                     notify the users in the room about the message
-h, --help                       Show the options and sample usage

Environment Variables

You can use Environment Variables to set common values instead of passing them in via the command line options.

  • username: HIPCHAT_API_USERNAME
  • room: HIPCHAT_API_ROOM
  • token: HIPCHAT_API_TOKEN

More CLI bins!

It would be awesome to have more commands added to this tool, either as a command or as a standalone bin. If you want to add one, please follow the contribution guidelines below.

Some ideas:

  • create a room
  • update a topic
  • create a user
  • delete a user

.. pretty much anything the HipChat API supports. 👍

Contributing

  1. Check master to make sure your idea hasn't already been created
  2. Fork the repo
  3. Add your changes. Make sure the tests pass (if any)
  4. Submit a pull request.

Copyright

Copyright (c) 2013 Jeremy Baker. See LICENSE for details