Skip to content

GitHub CLI extension to display GitHub notifications

License

Notifications You must be signed in to change notification settings

PhateValleyman/gh-notify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GitHub CLI Notification Extension

gh extension to interact with GitHub notifications.

Install

gh extension install meiji163/gh-notify

Install the Fuzzy Finder (fzf) for interactive mode.

Usage

demo

gh notify [-Flag]
Flag Description Example
show all unread notifications gh notify
-a show all (read/ unread) notifications gh notify -a
-r mark all notifications as read gh notify -r
-e exclude notifications matching a string (REGEX support) gh notify -e "MyJob"
-f filter notifications matching a string (REGEX support) gh notify -f "Repo"
-s print a static display gh notify -as
-n NUM max number of notifications to show gh notify -an
-p show only participating or mentioned notifications gh notify -ap
-w display the preview window in interactive mode gh notify -an 10 -w
-h show the help page gh notify -h

HotKeys for interactive mode with Fuzzy Finder (fzf)

HotKey Description
? toggle help
tab toggle preview notification
enter print notification and exit
shift+↑↓ scroll the preview up/ down
ctrl+b open notification in browser
ctrl+r mark all notifications as read and exit
ctrl+x write a comment with the editor and exit
esc exit

Customizations

Fuzzy Finder (fzf)

Customize fzf colors and key bindings by exporting ENVIRONMENT VARIABLES to your .zshrc/.bashrc. See the man page (man fzf) for AVAILABLE KEYS/ EVENTS or junegunn/fzf#environment-variables on GitHub for more details.

# ~/.zshrc
# The following examples allow you to clear the input query with alt+c,
# jump to the first/last result with alt+u/d, refresh the preview window with alt+r
# and scroll the preview in larger steps with ctrl+w/s.
export FZF_DEFAULT_OPTS="
--bind 'alt-c:clear-query'
--bind 'alt-u:first,alt-d:last'
--bind 'alt-r:refresh-preview'
--bind 'ctrl-w:preview-half-page-up,ctrl-s:preview-half-page-down'
..."`

GitHub command line tool (gh)

In the configuration file of the gh tool you can set your preferred editor. This is handy when you use the interactive mode to write a comment on a notification.

# See more details
gh config
# For example, set the editor to Visual Studio Code or Vim.
gh config set editor "code --wait"
gh config set editor vim

About

GitHub CLI extension to display GitHub notifications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%