justinmk/guh.nvim
github
122
13
4
4
guh.nvim
[!NOTE] This plugin is pretty sweet, but still WIP/beta. PRs/feedback welcome!
Work with GitHub in Neovim. Guh is ~2k lines of unimpeachable code, leveraging builtin Nvim
mechanisms such as diagnostics, 'scrollbind', progress messages and 'winbar', otherwise delegating
to the gh CLI in a :terminal buffer.
- Minimal (10x smaller than Octo.nvim).
- No config.
- One command:
:Guh - View any GitHub object, including CI logs.
- Review PRs.
- Read notifications.
Usage
Run :Guh to see the current repo status (commits/PRs/issues), or the global "guh://status"
(notifications) page if no repo can be guessed from the current buffer or directory.
:Guh
Run :Guh <target> to view a PR/issue/commit/repo.
" PR or issue number (current repo)
:Guh 35951
" Commit SHA
:Guh a1b2c3d
" Branch
:Guh neovim/neovim/tree/release-0.11
" GitHub URL
:Guh https://github.com/neovim/neovim/pull/35951
:Guh https://github.com/neovim/neovim/commit/a1b2c3d
:Guh https://github.com/neovim/neovim/tree/release-0.11
" Slug ("owner/repo#123" or "owner/repo")
:Guh neovim/neovim#35951
:Guh neovim/neovim
" guh:// URI
:Guh guh://neovim/neovim/pr/35951
" Cursor target
:Guh .
Inside any guh:// buffer,
- Hit
g?to see the keymaps. - Hit
<Enter>to open the target at cursor. - Hit
-to go "up" (to PR overview ⇒ repo overview ⇒ user notifications). - Hit
gXto open the github.com web UI of the current buffer.
When viewing a PR,
- Diff comments are presented (1) in a 'scrollbind' split, (2) as "diagnostics" (
vim.diagnostic), (3) loaded in quickfix. - Files marked as "Viewed" are collapsed to a
(viewed) <path>line. - You can view the most-recent CI logs for all "jobs" in the CI matrix.
Editable buffers (comments, merge message) confirm the action on write-and-close (ZZ submits, ZQ
discards).
Keymaps are provided as <Plug>(guh-…). To customize, just define a mapping to the relevant
<Plug>(guh-…) and Guh will skip its default.
See help file for details.
Install
vim.pack.add{ 'https://github.com/justinmk/guh.nvim' }
Requirements:
- Nvim 0.13+
- "gh" (GitHub CLI)
- (Optional) For working with Git, use a plugin such as vim-fugitive.
- (Optional) For highlighting diffs, use a plugin such as diffs.nvim.
- (Optional) For improved Markdown rendering, use a plugin such as render-markdown.nvim.
Related
Credits
guh.nvim was originally forked (and completely rewritten) from https://github.com/daliusd/ghlite.nvim by Dalius Dobravolskas.