Skip to content

samdfonseca/hipcat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hipcat

HipCat is a simple commandline utility to post snippets to HipChat.

hipcat

Quickstart

Install

go get github.com/samdfonseca/hipcat

Configuration

Generate a personal access token for HipCat: https://hipchat.com/account/api

Create a HipCat config file:

echo "auth_token = <your-hipchat-token>" >> ~/.hipcat

Set a default room to send to:

echo "default_room_name = Notification Room" >> ~/.hipcat
OR
echo "default_room_id = 1234567" >> ~/.hipcat

(Room ID is slightly faster since it saves one request to the HipChat API to lookup the room id)

Usage

Pipe command output as a message or several messages to the default room:

$ tail -F -n0 /path/to/log | hipcat --tee --stream
hipcat file hello uploaded to Notification Room

Pipe command output as a message or several messages to some other room:

$ tail -F -n0 /path/to/log | hipcat --stream -r "Notification Room"
hipcat starting stream
hipcat posted 10 message lines to Notification Room

Post an existing file:

$ hipcat --room "Entire Company" /home/user/bot.png
hipcat file bot.png uploaded to general

Stream input continously as a formatted message, and print stdin back to stdout:

curl https://google.com | hipcat --tee --stream
hipcat starting stream
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   220  100   220    0     0   1252      0 --:--:-- --:--:-- --:--:--  1257
<HTML><HEAD><meta http-equiv="content-type" content="text/html;charset=utf-8">
<TITLE>301 Moved</TITLE></HEAD><BODY>
<H1>301 Moved</H1>
The document has moved
<A HREF="https://www.google.com/">here</A>.
</BODY></HTML>
hipcat flushing remaining messages to HipChat...
hipcat posted 6 message lines to TitaniumHipTest

Options

Option Description
--tee, -t Print stdin to screen before posting
--stream, -s Stream messages to HipChat continuously instead of uploading a single snippet
--plain, -p When streaming, write messages as plain text instead of code blocks
--noop Skip posting file to HipChat. Useful for testing
--room, -r HipChat channel, group, or user to post to
--filename, -n Filename for upload. Defaults to given filename or current timestamp if reading from stdin.

About

HipCat is a simple commandline utility to post snippets to HipChat. A shameless ripoff of http://slackcat.chat/

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published