Giter Site home page Giter Site logo

bash-hipchat's Introduction

bash-hipchat

Send hipchat notifications from the command line

Requirements

  • curl on the commandline
  • getopts support in your shell

Tested against

  • bash version 3.2

Installation

Create a directory to hold your personal shell scripts:

cd ~
mkdir -p scripts

Then clone this repo there

cd ~/scripts
git clone https://github.com/josegonzalez/bash-hipchat.git

Then add this directory to your PATH within your .bashrc or .bash_profile:

export PATH=${PATH}:${HOME}/scripts/hipchat

Usage

Run the following command:

hipchat -h

To get usage instructions:

hipchat

usage:

  -h                - This help screen
  -a AUTH_TOKEN     - Authentication token (no default)
  -c COLOR          - Color of notification (default: yellow)
  -f FROM           - Who to send from (default: Nobody)
  -m MESSAGE_FORMAT - Message format (default: html)
  -n NOTIFY         - Whether to notify channel users (default: 0)
  -r ROOM_ID        - Room id (default: 31226)

TODO

  • Some sort of unit testing
  • Fallback for installations without curl - wget?
  • Proper exit code based on curl response

License

MIT License

bash-hipchat's People

Contributors

josegonzalez avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.