/README.md

https://github.com/kfdm/growlme · Markdown · 48 lines · 33 code · 15 blank · 0 comment · 0 complexity · 97b070e3a1f0eb56183ef55da897ef4a MD5 · raw file

  1. growlme
  2. =======
  3. Growlme is a simple command-line tool to execute a command in a subshell and notify growl of success
  4. or failure:
  5. $ growlme ant clean package
  6. To make growl receive remote notifications, you need to turn on "Allow remote application
  7. registration" in the "Network" tab of growl's preferences panel. Set a password, and put that
  8. password in `~/.growlpass` or pass it via the `-P` parameter. You'll need to go back to General tab,
  9. hit Stop Growl, then start it back up and allow it to accept network connections.
  10. In the simplest case, growlme runs locally on a machine that is running growl, and sends the
  11. notification over a local UDP port. But it can also work over a LAN if the `SSHCLIENT` environment
  12. variable is set, or you pass a hostname explicitly via the `-H` parameter.
  13. By default, the notification's title is "(hostname): (command)" and the message is either
  14. "Succeeded" or "FAILED". You can change any of these on the command line (see `--help`).
  15. Credits
  16. -------
  17. Most of the code is Rui Carmo's "netgrowl", included inline and edited down a bit. You can find the
  18. original [on his web site](http://the.taoofmac.com/space/Projects/netgrowl). Greg added the CLI
  19. wrapper and Robey generalized it into a something that executes other programs.
  20. Icons taken from here
  21. [Alarm-Tick-Icon](http://www.iconarchive.com/show/ivista-2-icons-by-gakuseisean/Alarm-Tick-icon.html)
  22. [Alarm-Fail-Icon](http://www.iconarchive.com/show/ivista-2-icons-by-gakuseisean/Alarm-Error-icon.html)
  23. License
  24. -------
  25. Licensed under the Apache License, Version 2.0 (the "License"); you may not
  26. use this file except in compliance with the License. You may obtain a copy
  27. of the License at
  28. http://www.apache.org/licenses/LICENSE-2.0
  29. Unless required by applicable law or agreed to in writing, software
  30. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  31. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  32. License for the specific language governing permissions and limitations
  33. under the License.