Skip to content
Get packs

Guide · Open source

How to use gh-dash: install, configure sections and navigate PRs

Updated · written with AI from the project's own documentation and checked against our catalogue data

gh-dash is a terminal user interface for GitHub that shows pull requests and issues in sections you define. It is built for developers who already spend their day in the terminal and want a keyboard-driven view of their work. After this guide you will know how to install it, where its settings live, and how to use it to review and act on pull requests and issues.

gh-dashdlvhdr/gh-dash · ★ 12.7k · MIT

Quick start

  1. 1Install GitHub CLI. Make sure the GitHub CLI (gh) is installed, since gh-dash runs as one of its extensions.
  2. 2Install gh-dash. Run the extension install command from the README to add gh-dash to gh.
  3. 3Open the docs. Read the getting-started guide at gh-dash.dev to learn the config format.
  4. 4Create your YAML config. Define sections for the PRs and issues you want to track, scoped per repo if needed.
  5. 5Launch and navigate. Start gh-dash and move between sections with vim-style keys.
  6. 6Act on items. Open a PR to view its diff, comment, check out its branch or push changes.

Install gh-dash as a GitHub CLI extension

gh-dash runs on top of the GitHub CLI (gh), so you need gh installed first. The project's README installs gh-dash as a GitHub CLI extension with a single command.

  • Prerequisite: GitHub CLI (gh)
  • Install method: package manager via gh extension
gh extension install dlvhdr/gh-dash

Understand what gh-dash shows you

gh-dash displays pull requests and issues in customizable sections. Sections are user-defined and can be scoped per repository, so you can keep PRs and issues for different projects in separate views.

Everything you can do on GitHub from the terminal is covered in the feature list, including viewing diffs, commenting, checking out branches, pushing and updating.

  • User-defined, per-repo PRs and issues sections
  • Diff, comment, checkout, push and update actions
  • Custom actions for your own workflow

Navigate with vim-style keyboard hotkeys

gh-dash uses vim-style keys, and the hotkeys can be overridden to match your own habits. If you already navigate with j and k in other tools, the layout will feel familiar.

  • Vim-style navigation by default
  • Hotkeys are overridable in the config

Configure sections with the YAML config file

All settings are controlled through a YAML config file. The README makes configuration central, so plan to spend some time here. Use the docs site at gh-dash.dev/getting-started for the full reference on the config format.

Define the sections you care about, such as PRs needing your review or issues in a specific repository, and gh-dash will show them as separate views.

  • Settings live in a YAML config file
  • Full reference: https://gh-dash.dev/getting-started

Work with pull requests from the terminal

Once your sections are set, you can open a pull request to view its diff, leave comments, check out its branch, and push changes without leaving the terminal. This keeps code review in the same keyboard-driven flow as the rest of your work.

  • View diffs
  • Comment on PRs and issues
  • Check out branches
  • Push and update changes

Get help and learn more

The docs site is the main reference. For questions, the project runs a Discord community, and contribution guidelines are published on the project site.

  • Docs: https://gh-dash.dev/getting-started
  • Discord community: https://discord.gg/SXNXp9NctV
  • Contributing guide: https://www.gh-dash.dev/contributing

What people use it for

  • Reviewing many pull requests in one keyboard-driven view
  • Tracking PRs and issues per repository in separate sections
  • Doing common GitHub actions without leaving the terminal
  • Adding a richer view on top of the GitHub CLI you already use

Frequently asked questions

How do I install gh-dash?

Install it as a GitHub CLI extension with gh extension install dlvhdr/gh-dash. You need the GitHub CLI (gh) installed first.

Is gh-dash free?

gh-dash is released under the MIT licence, which is an open-source licence. Check the repository's licence file for the full terms.

What do I need to run gh-dash?

The README lists the GitHub CLI (gh) as the prerequisite. gh-dash runs in a terminal and does not have a graphical interface.

How do I configure gh-dash?

All settings are controlled through a YAML config file. The docs site at gh-dash.dev/getting-started covers the format.

What are the alternatives to gh-dash?

The project lists gh (GitHub CLI), lazygit and tig as comparable projects. gh is the base CLI, while lazygit and tig are terminal interfaces for Git.

Can I change the keyboard shortcuts?

Yes. gh-dash uses vim-style hotkeys, and the README says they can be overridden.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

gh-dash suits developers who live in the terminal, review many pull requests, and already use the GitHub CLI. It is a poor fit if you prefer a graphical interface, rarely work with PRs or issues, or do not want to edit a YAML file to set up sections.

Install options & downloads