mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-29 07:41:58 +00:00

History

Tim O'Brien 797e1f9a64 [plugins/bgnotify] fix for iTerm2 notification clicks		2015-09-14 15:32:50 -07:00
..
bgnotify.plugin.zsh	[plugins/bgnotify] fix for iTerm2 notification clicks	2015-09-14 15:32:50 -07:00
README.md	Add screenshots to readme	2014-11-08 14:20:37 -08:00

README.md

bgnotify zsh plugin

cross-platform background notifications for long running commands! Supports OSX and Ubuntu linux.

Standalone homepage: t413/zsh-background-notify

How to use!

Just add bgnotify to your plugins list in your .zshrc

On OS X you'll need terminal-notifer
- brew install terminal-notifier (or gem install terminal-notifier)
On ubuntu you're already all set!
On windows you can use notifu or the Cygwin Ports libnotify package

Screenshots

Linux

OS X

Windows

Configuration

One can configure a few things:

bgnotify_threshold sets the notification threshold time (default 6 seconds)
function bgnotify_formatted lets you change the notification

Use these by adding a function definition before the your call to source. Example:

bgnotify_threshold=4  ## set your own notification threshold

function bgnotify_formatted {
  ## $1=exit_status, $2=command, $3=elapsed_time
  [ $1 -eq 0 ] && title="Holy Smokes Batman!" || title="Holy Graf Zeppelin!"
  bgnotify "$title -- after $3 s" "$2";
}

plugins=(git bgnotify)  ## add to plugins list
source $ZSH/oh-my-zsh.sh  ## existing source call