2014-11-07 02:34:26 +08:00
|
|
|
# bgnotify zsh plugin
|
|
|
|
|
|
2023-11-24 03:00:34 +08:00
|
|
|
cross-platform background notifications for long running commands! Supports OSX and Linux.
|
2014-11-07 02:34:26 +08:00
|
|
|
|
|
|
|
|
Standalone homepage: [t413/zsh-background-notify](https://github.com/t413/zsh-background-notify)
|
|
|
|
|
|
2023-11-24 03:00:34 +08:00
|
|
|
---
|
2014-11-07 02:34:26 +08:00
|
|
|
|
2023-11-24 03:00:34 +08:00
|
|
|
## How to use
|
2014-11-07 02:34:26 +08:00
|
|
|
|
|
|
|
|
Just add bgnotify to your plugins list in your `.zshrc`
|
|
|
|
|
|
2018-01-23 11:14:32 +08:00
|
|
|
- On OS X you'll need [terminal-notifier](https://github.com/alloy/terminal-notifier)
|
2014-11-07 02:34:26 +08:00
|
|
|
* `brew install terminal-notifier` (or `gem install terminal-notifier`)
|
2023-11-24 03:00:34 +08:00
|
|
|
- On Linux, make sure you have `notify-send` or `kdialog` installed. If you're using Ubuntu you should already be all set!
|
|
|
|
|
- On Windows you can use [notifu](https://www.paralint.com/projects/notifu/) or the Cygwin Ports libnotify package
|
2014-11-07 02:34:26 +08:00
|
|
|
|
|
|
|
|
|
2014-11-09 06:20:37 +08:00
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
**Linux**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**OS X**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Windows**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-11-07 02:34:26 +08:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
One can configure a few things:
|
|
|
|
|
|
2023-12-02 00:09:48 +08:00
|
|
|
- `bgnotify_bell` enabled or disables the terminal bell (default true)
|
2014-11-07 02:34:26 +08:00
|
|
|
- `bgnotify_threshold` sets the notification threshold time (default 6 seconds)
|
2023-11-24 03:00:34 +08:00
|
|
|
- `function bgnotify_formatted` lets you change the notification. You can for instance customize the message and pass in an icon.
|
2024-09-16 05:20:59 +08:00
|
|
|
- `bgnotify_extraargs` appends extra args to notifier (e.g. `-e` for notify-send to create a transient notification)
|
2014-11-07 02:34:26 +08:00
|
|
|
|
|
|
|
|
Use these by adding a function definition before the your call to source. Example:
|
|
|
|
|
|
2023-11-24 03:00:34 +08:00
|
|
|
```sh
|
2023-12-02 00:09:48 +08:00
|
|
|
bgnotify_bell=false ## disable terminal bell
|
2014-11-07 02:34:26 +08:00
|
|
|
bgnotify_threshold=4 ## set your own notification threshold
|
|
|
|
|
|
|
|
|
|
function bgnotify_formatted {
|
|
|
|
|
## $1=exit_status, $2=command, $3=elapsed_time
|
2023-11-24 03:00:34 +08:00
|
|
|
|
|
|
|
|
# Humanly readable elapsed time
|
|
|
|
|
local elapsed="$(( $3 % 60 ))s"
|
|
|
|
|
(( $3 < 60 )) || elapsed="$((( $3 % 3600) / 60 ))m $elapsed"
|
|
|
|
|
(( $3 < 3600 )) || elapsed="$(( $3 / 3600 ))h $elapsed"
|
|
|
|
|
|
|
|
|
|
[ $1 -eq 0 ] && title="Holy Smokes Batman" || title="Holy Graf Zeppelin"
|
|
|
|
|
[ $1 -eq 0 ] && icon="$HOME/icons/success.png" || icon="$HOME/icons/fail.png"
|
|
|
|
|
bgnotify "$title - took ${elapsed}" "$2" "$icon"
|
2014-11-07 02:34:26 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
plugins=(git bgnotify) ## add to plugins list
|
|
|
|
|
source $ZSH/oh-my-zsh.sh ## existing source call
|
2023-11-24 03:00:34 +08:00
|
|
|
```
|
