- depends on
terminal-notifiersource (macos) and this will be installed automatically if you use the install script provided. (On linux the equivalent dependency isnotify-sendwhich will not be installed automatically). - installation (or standalone binary) depends on having a
GH_NOTIFIER_TOKENenvironment variable set to a personal access token with Notifications scope.
GH_NOTIFIER_TOKEN=<INSERT TOKEN HERE> ./install.shThe token will be stored in the launchd plist xml and the install script can be rerun if the token changes, or alternatively the variable in ~/Library/LaunchAgents/com.gh-notifier.plist can be manually updated.
./uninstall.shOnce installed, the daemon, managed by launchd, polls the GitHub notifications API at 30 second intervals and displays desktop notifications for any new GitHub notifications received.
Without installation, the binary in dist/ can be used for a one-off call, or be scheduled at the desired interval with crontab. Bear in mind that both the GH_NOTIFIER_TOKEN and a $PATH variable with /opt/homebrew/bin/ will need to be available.