base on A beautiful CLI dashboard for GitHub š # gh-dash
⨠A GitHub (`gh`) CLI extension to display a dashboard with **pull requests** and **issues** by filters you care about.
<a href="https://github.com/charmbracelet/bubbletea/releases"><img src="https://img.shields.io/github/release/dlvhdr/gh-dash.svg" alt="Latest Release"></a>
<img src="https://user-images.githubusercontent.com/6196971/198704107-6775a0ba-669d-418b-9ae9-59228aaa84d1.gif" />
## š Docs
See the docs site at [dlvhdr.github.io/gh-dash](https://dlvhdr.github.io/gh-dash) to get started.
## ā Why use gh-dash
Check out this 10/10 video by [charm.sh āØ](https://charm.sh) explaining how gh-dash can help you manage your GitHub experience.
[](https://www.youtube.com/watch?v=5omFxcNjBQk&t "Manage open source like a boss (in the terminal)")
## ⨠Features
- š
fully configurable - define sections using GitHub filters
- š search for both prs and issues
- š customize columns with `hidden`, `width` and `grow` props
- ā”ļø act on prs and issues with checkout, comment, open, merge, diff, etc...
- āØļø set custom actions with new keybindings
- š
use custom themes
- š view details about a pr/issue with a detailed sidebar
- šŖ write multiple configuration files to easily switch between completely different dashboards
- ā»ļø set an interval for auto refreshing the dashboard
- š smart filtering - auto-filter pr/issue lists to the remote tracked by the current directory
## š¦ Installation
1. Install the `gh` CLI - see the [installation](https://github.com/cli/cli#installation)
_Installation requires a minimum version (2.0.0) of the GitHub CLI that supports extensions._
2. Install this extension:
```sh
gh extension install dlvhdr/gh-dash
```
3. To get the icons to render properly you should download and install a Nerd font from https://www.nerdfonts.com/.
Then, select that font as your font for the terminal.
<details>
<summary>Installing Manually</summary>
> If you want to install this extension **manually**, follow these steps:
1. Clone the repo
```shell
# git
git clone https://github.com/dlvhdr/gh-dash
```
```shell
# GitHub CLI
gh repo clone dlvhdr/gh-dash
```
2. Cd into it
```bash
cd gh-dash
```
3. Build it
```bash
go build
```
4. Install it locally
```bash
gh extension install .
```
</details>
<details>
<summary>Updating from an older version</summary>
```bash
gh extension upgrade dlvhdr/gh-dash
```
</details>
<details>
<summary>How do I get these exact colors and font?</summary>
> I'm using [Alacritty](https://github.com/alacritty/alacritty) with the [tokyonight theme](https://github.com/folke/tokyonight.nvim) and the [Fira Code](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/FiraCode) Nerd Font.
> For my full setup check out [my dotfiles](https://github.com/dlvhdr/dotfiles/blob/main/.config/alacritty/alacritty.yml).
</details>
## ā”ļø Usage
Run
```sh
gh dash
```
Then press <kbd>?</kbd> for help.
Run `gh dash --help` for more info:
```
Usage:
gh dash [flags]
Flags:
-c, --config string use this configuration file
(default lookup:
1. a .gh-dash.yml file if inside a git repo
2. $GH_DASH_CONFIG env var
3. $XDG_CONFIG_HOME/gh-dash/config.yml
)
--debug passing this flag will allow writing debug output to debug.log
-h, --help help for gh-dash
```
## āļø Configuring
You can find all the details in the docs site under [gh-dash/configuration](https://dlvhdr.github.io/gh-dash/configuration).
Example configurations can be found on GitHub:
- The config for the gh-dash repo under [.gh-dash.yml](https://github.com/dlvhdr/gh-dash/blob/main/.gh-dash.yml)
- My config under my dotfiles repo [dlvhdr/dotfiles](https://github.com/dlvhdr/dotfiles/blob/main/nix/module/gh-dash/configs/config.yml)
- Many other configs found by [searching GitHub](https://github.com/search?q=path%3Agh-dash%2Fconfig.yml&type=code)
## š Under the hood
gh-dash uses:
- [bubbletea](https://github.com/charmbracelet/bubbletea) for the TUI
- [lipgloss](https://github.com/charmbracelet/lipgloss) for the styling
- [glamour](https://github.com/charmbracelet/glamour) for rendering markdown
- [vhs](https://github.com/charmbracelet/vhs) for generating the GIF
- [cobra](https://github.com/spf13/cobra) for the CLI
- [gh](https://github.com/cli/cli) for the GitHub functionality
- [delta](https://github.com/dandavison/delta) for viewing PR diffs
## Author
Dolev Hadar
[email protected]
", Assign "at most 3 tags" to the expected json: {"id":"12702","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"