PRやissuesの一覧をターミナル上でイイ感じにまとめるgh dashを使ってみた
概要
GitHub社は2020年にGitHubをコマンドライン上から操作できるGitHub CLIをリリースしました。
その後2021年にGitHub CLI 2.0をリリースしました。
2.0では拡張機能をサポートしており、誰でもカスタムコマンドを作成できます。 gh extension browseもしくはgh extension searchで他の人が作成し公開した拡張機能を表示させます。
- gh extension brose
- gh extension search
Showing 30 of 336 extensions
REPO DESCRIPTION
✓ dlvhdr/gh-dash A beautiful CLI dashboard for GitHub 🚀
seachicken/gh-poi ✨ Safely clean up your local branches
jrnxf/gh-eco 🦎 gh cli extension to explore the ecosystem
github/gh-actions-importer GitHub Actions Importer helps you plan and automate the migration of Azure DevOps, C...
yusukebe/gh-markdown-preview GitHub CLI extension to preview Markdown looks like GitHub.
gennaro-tedesco/gh-s 🔎 search github repositories interactively
github/gh-gei Migration CLI for GitHub to GitHub migrations
actions/gh-actions-cache A GitHub (gh) CLI extension to manage the GitHub Actions caches being used in a GitH...
github/gh-net A network bridge between a Codespace and a local machine.
mislav/gh-branch GitHub CLI extension for fuzzy finding, quickly switching between and deleting branc...
gennaro-tedesco/gh-f 🔎 the ultimate compact fzf gh extension
Link-/gh-token Create an installation access token for a GitHub app from your terminal 💻
k1LoW/gh-grep :octocat: Print lines matching a pattern in repositories using GitHub API
davidraviv/gh-clean-branches Safely deletes local branches with no upstream and no un-pushed commits
vilmibm/gh-screensaver full terminal animations
redraw/gh-install install GitHub release binaries from the CLI interactively
meiji163/gh-notify GitHub CLI extension to display GitHub notifications
KOBA789/gh-sql Query GitHub Projects with SQL
advanced-security/gh-sbom Generate SBOMs with gh CLI
kawarimidoll/gh-graph GitHub contribution graph in your terminal
korosuke613/gh-user-stars Displays an interactive and searchable list of your GitHub starred repositories
chelnak/gh-changelog A gh cli extension that will make your changelogs ✨
matt-bartel/gh-clone-org A github-cli extension script to clone all repositories in an organization, optional...
rnorth/gh-combine-prs A `gh` extension for combining multiple PRs (e.g. Dependabot PRs) into one.
mislav/gh-cp GitHub CLI extension to copy a file from a GitHub repository locally without cloning...
gabe565/gh-profile :octocat: Use multiple GitHub accounts with the gh cli.
github/gh-projects gh-projects
vilmibm/gh-user-status set and get github user statuses
このリストの並びはデフォルトでスターの数が多い順に表示されているのですが、トップのdlvhdr/gh-dashは2位と比べて10倍近い差をつけてスターを獲得しています。
-
gh-dash
-
gh-poi
このgh-dashとはどんな機能なのかインストールして試してみます。
gh-dash
gh-dashはGitHubのPRやissuesの一覧をターミナル上にダッシュボードで表示させてくれます。
READMEより[1]
インストール方法
以下のコマンドでインストールできます。
gh extension install dlvhdr/gh-dash
ただデモ動画のようにアイコンをターミナル上に表示させる場合、Nerd Fontsをインストールする必要があります。
使い方
Nerd Fontsのインストールまで完了しましたら、gh dashコマンドを実行することで自身のGitHubのPRやissuesのリストをダッシュボード上に表示できます。
？ボタンでコマンドヘルプ表示
Configuring
gh-dashの特徴として自分でダッシュボードを自由にカスタマイズできます。インストール時に~/.config/gh-dash/config.ymlが作成され、引数なしで実行した場合このファイルを自動的に読み込みます。
prSections:
- title: My Pull Requests
filters: is:open author:@me
- title: Needs My Review
filters: is:open review-requested:@me
- title: Involved
filters: is:open involves:@me -author:@me
issuesSections:
- title: My Issues
filters: is:open author:@me
- title: Assigned
filters: is:open assignee:@me
- title: Involved
filters: is:open involves:@me -author:@me
defaults:
preview:
open: true
width: 50
prsLimit: 20
issuesLimit: 20
view: prs
layout:
prs:
updatedAt:
width: 7
repo:
width: 15
author:
width: 15
assignees:
width: 20
hidden: true
base:
width: 15
hidden: true
lines:
width: 16
issues:
updatedAt:
width: 7
repo:
width: 15
creator:
width: 10
assignees:
width: 20
hidden: true
refetchIntervalMinutes: 30
keybindings:
issues: []
prs: []
repoPaths: {}
pager:
diff: ""
prSectionsがPRでissuesSectionsがissuesのダッシュボード構成になります。titleセクションにダッシュボード上の項目名、filtersセクションにどのリポジトリか、起案中かクローズ済みか、特定作者のみを表示させるか除外させるかなどルール付けを設定できます。
またconfig.ymlは明示的に指定でき、config.ymlを複数作成することで仕事用と個人用で複数のダッシュボードを用意できます。
prSections:
- title: My Pull Requests
filters: is:open author:@me
- title: Needs My Review
filters: is:open review-requested:@me
- title: Involved
filters: is:open involves:@me -author:@me
- title: Subscribed #自分以外のGitHub CLIやgh-dashのPRを表示
filters: is:open -author:@me repo:cli/cli repo:dlvhdr/gh-dash
limit: 50 # optional limit of rows fetched for this section
issuesSections:
- title: My Issues
filters: is:open author:@me
- title: Assigned
filters: is:open assignee:@me
- title: Involved
filters: is:open involves:@me -author:@me
- title: Subscribed
filters: is:closed -author:@me repo:cli/cli #クローズ済みのGitHub CLIのissuesを表示
gh dash -c <path/to/config.yml>
- GitHub CLIリポジトリのクローズされてるissuesのみを表示
テーマカスタマイズ
themeセクションで自由にダッシュボードの文字色や背景色をカスタマイズできます。
theme:
colors:
text:
primary: "ff7f00"
secondary: "#666CA6"
inverted: "#242347"
faint: "#3E4057"
warning: "#F23D5C"
success: "#3DF294"
background:
selected: "#39386B"
border:
primary: "#383B5B"
secondary: "#39386B"
faint: "#2B2B40"
-
デフォルトテーマ
-
カスタマイズテーマ
前述のように仕事用と個人用のリポジトリで分けてカスタマイズすればダッシュボードの取り違いを減らせると思います。
所感
GitHub CLIの拡張機能で最もスターが多いgh-dashについて紹介しました。
本当はキーバインド機能も紹介したかったのですが、やり方が悪かったのかうまく試せませんでした。
GitHub CLIの登場以降どんどんGitHub上の操作がコマンドライン上で完結できるようになったと感じます。ブラウザとターミナル間を何回も行き来するのは地味にストレスでしたので開発体験も向上すると思います。
GitHub CLIの拡張機能は他にも面白いものがありますので気になりましたらgh extension browseで探してみてください。
参考文献
Discussion