mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-09-19 04:01:21 +02:00

History

Marc Cornellà a04cf07880 refactor(bgnotify): clean up and reorganize code 🗸 Standardize code style 🗸 Organize code sections 🗸 Optimize calls for window ID		2022-11-11 09:53:21 +01:00
..
bgnotify.plugin.zsh	refactor(bgnotify): clean up and reorganize code	2022-11-11 09:53:21 +01:00
README.md	use https everywhere (#6574 )	2018-08-07 20:42:01 +02: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-notifier
- 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