How do I set up gh.nvim for code reviews?

Install git and gh CLI tools, then add gh.nvim and its dependency litee.nvim to your Neovim config using a plugin manager like lazy.nvim, and configure it with optional fzf.lua or Telescope for UI selection, as detailed in the README.

gh.nvim vs GitHub web UI: which is better for reviews?

gh.nvim is superior for complex reviews needing local context and LSP tools, while the web UI is better for quick reviews, collaborative features like real-time comments, and integrated CI checks without local setup.

Can gh.nvim handle private GitHub repositories?

Yes, as long as you have authenticated the gh CLI with your GitHub account and have access to the repository, gh.nvim will work with private repos by fetching and checking out the code locally.

How to submit a comment on a pull request with gh.nvim?

Inside a conversation buffer, use the configured keymap (default ) to submit comments, and you can draft responses by editing the local code directly before submitting, as per the plugin's keymap settings.

What if gh.nvim fails to fetch a pull request?

Check your gh CLI authentication and network connection, ensure the repository exists and you have permissions, and verify that the Git remote is correctly added, as the plugin relies on external tools for automation.

Are there alternatives to gh.nvim for Neovim?

Alternatives include vim-fugitive for basic Git integration and custom scripts, but gh.nvim is specifically designed for GitHub code reviews with local context and automation, though it has more dependencies.

Open-Awesome

gh.nvim

MITLua

A Neovim plugin for performing GitHub code reviews locally with full editor tooling and automation.

GitHub

647 stars31 forks0 contributors

What is gh.nvim?

gh.nvim is a Neovim plugin that integrates GitHub code reviews directly into the editor. It solves the problem of lacking context and tooling when reviewing pull requests in the GitHub web UI by locally checking out PR code, enabling full LSP support, editing, and local execution.

Target Audience

Neovim users who regularly review or contribute to GitHub pull requests and want to perform reviews within their editor using familiar tools and workflows.

Value Proposition

It uniquely automates the local checkout of PR code, turning Neovim into a powerful code review environment with full editor capabilities, eliminating the need to switch between browser and editor.

Overview

A fully featured GitHub integration for performing code reviews in Neovim.

Use Cases

Best For

Reviewing complex pull requests in large codebases where context is critical
Using LSP features like find references or rename during code review
Editing PR code locally to test changes or draft review responses
Running local development environments with PR code for sanity checks
Automating Git operations for fetching and checking out PR branches
Integrating code review workflows with fzf.lua or Telescope for UI selection

Not Ideal For

Teams that rely heavily on GitHub's web-based collaborative features like real-time comment threading and integrated CI status checks
Developers using editors other than Neovim or those who prefer lightweight, browser-only review tools
Projects with frequent, small pull requests where the overhead of local checkout and plugin configuration is unnecessary

Pros & Cons

Pros

Local Context Access

Checks out PR code locally, providing full project context for understanding complex changes, directly addressing the frustration of lacking context in web UI reviews.

Full LSP Integration

Enables language server protocol tools on PR code, allowing features like find references and renaming during reviews, as highlighted in the README for better code understanding.

Automated Git Workflow

Automatically fetches remote branches and checks out PR heads using an embedded Git CLI wrapper, reducing manual steps and streamlining the review process.

Editable Review Environment

Allows direct editing of PR code in Neovim for drafting responses, building diffs, and running local development environments, enhancing review efficiency.

Cons

Complex Setup Dependencies

Requires installation and configuration of multiple external tools (git, gh CLI) and Neovim plugins (litee.nvim, fzf.lua/Telescope), which can be time-consuming and error-prone.

Neovim-Exclusive Limitation

Only works within Neovim, excluding users of other editors or IDEs who might benefit from similar local review capabilities.

Overhead for Simple Reviews

The local checkout and full editor integration may be unnecessary for straightforward pull requests that are easily reviewed in the web UI, adding setup complexity without proportional benefit.

Frequently Asked Questions

Related Projects

octo.nvim

Edit and review GitHub issues and pull requests from the comfort of your favorite editor

Stars3,289

Forks232

Last commit6 days ago

gist.nvim

Neovim plugin that allows you to create a Github Gist from the current file

Stars215

Forks8

Last commit12 days ago

pipeline.nvim

See status of ci/cd pipeline runs directly in neovim. Currently supports GitHub Actions and GitLab CI.

Stars182

Forks12

Last commit17 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub