gh-dash README

The project's README from github.com/dlvhdr/gh-dash. As one markdown file: README.md.


Text changing depending on mode. Light: 'So light!' Dark: 'So dark!'

→ https://gh-dash.dev ←

A rich terminal UI for GitHub that doesn't break your flow.

Latest Release Discord


❤️ Sponsoring

If you enjoy DASH and want to help, consider supporting the project with a donation at the sponsors page.

Thank you to all past and existing sponsors! 🙏🏽

Sponsors

TUI Innovator

Owen Cabalceta  

TUI Visionary

Architect   Peter Steinberger  

TUI Power User

Alexander Garber   Brend Smits   Brian Gianforcaro   cdxn   Ken Sanders   Luke Rollans   Matthew Chisolm   Nikolay Kolev   Philippe Serhal   Scott Ames   sideshowbarker   Spencer Judd   Stefan Lüdin   Stevie Huh   Ulrich Dangel   vosahloj   Will Cory  

TUI Backer

Jeff Wainwright   purajit  

🌟 Features

If you like quickly navigating with your keyboard, seeing the PRs and issues you need and you love the terminal - DASH is for you! 🫵🏽

📃 Docs

DASH has an extensive docs site at gh-dash.dev/getting-started.

👥 Discord

Have questions? Join our Discord community!

🙏 Contributing

See the contribution guide at https://www.gh-dash.dev/contributing.

🛞 Under the hood

DASH uses:

Authors

Dolev Hadar (@dlvhdr) and the community.

gh-dash (dlvhdr/gh-dash)

Searching Database…

12.6K ·GitHub
What is this?gh-dash is a terminal UI (TUI) dashboard that shows your GitHub pull requests and issues right in the terminal, so you never have to switch to a browser to check them.
Is this a standalone app or a GitHub CLI extension?It's an extension for the official GitHub CLI (gh), written in Go and built with the Bubble Tea TUI framework, not a separate app you download.
How do I install and run it?Install it as a gh extension with 'gh extension install dlvhdr/gh-dash' and launch it by running 'gh dash'. Full setup steps are on the docs site at gh-dash.dev/getting-started.
Do I need the GitHub CLI installed first?Yes — since gh-dash is a gh extension, you need the official GitHub CLI (gh) installed and authenticated before gh-dash can talk to GitHub.
What can I actually do with a PR without leaving the dashboard?You can view diffs, comment, checkout, push, and update pull requests — basically everything you could do on github.com, right from the terminal.
Can I change the default keyboard shortcuts?Yes, gh-dash ships with vim-style hotkeys by default, but every keybinding is overridable through the config.
How are PR diffs and markdown rendered in the terminal?gh-dash uses 'delta' for syntax-highlighted PR diff viewing and 'glamour' for rendering markdown such as issue and PR descriptions.
Can I organize sections per repository?Yes, PR and issue sections are user-defined and per-repo, so you can group your work exactly how you like via the YAML config file.
What are similar projects?veet, superfile, sampler, lazygit, posting, tuios, gh-secure, slides
Creator
dlvhdr
Size
57.1 MB
Stars
12.6K
Age
5y
Commits · 90 Days