A Polybar module to show unread notifications from GitHub
npm install polybar-githubA Polybar module to show unread notifications from GitHub
This is a Node.js module available through the
npm registry. It can be installed using thenpm
oryarn
command line tools.
``sh`
npm install --global polybar-github
Cli:
`bash`
polybar-github FILE GH_TOKEN TIME/s MODE NOTIFICATIONall+participating
- File: tail file
- Gh-Token: GitHub Token
- Time: Interval
- Mode:
- Default: all
- :AllNotificationsNumber
- Format: all+participating
- Notification: All types
- :AllNotificationsNumber (AllParticipatingNumber)
- Format: participating
- Notifcation: Participating
- :AllParticipatingNumber
- Format: true
- Notifcation: Participating
- Notification: or false.true
- Default:
Polybar Config:
```
; Polybar GitHub
[module/github]
type = custom/script
format-prefix = "GitHub: "
exec = polybar-github $HOME/.config/polybar/.env/github $TOKEN 60 all true
click-left = echo left >> $HOME/.config/polybar/.env/github
click-middle = echo middle >> $HOME/.config/polybar/.env/github
click-right = echo right >> $HOME/.config/polybar/.env/github
scroll-up = echo scrollUp >> $HOME/.config/polybar/.env/github
scroll-down = echo scrollDown >> $HOME/.config/polybar/.env/github
tail = true
And create a file in $HOME/.config/polybar/.env/github.
- @octokit/rest: GitHub REST API client for Node.js
- node-notifier: A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)
- polybar-helpers: Polybar - Helpers to create plugin/module using NodeJS
MIT