gh-dash 项目使用教程

gh-dash 项目使用教程

gh-dash A beautiful CLI dashboard for GitHub 🚀 项目地址: https://gitcode.com/gh_mirrors/gh/gh-dash

1. 项目介绍

gh-dash 是一个用于 GitHub 的漂亮 CLI 仪表盘工具。它作为 GitHub CLI (gh) 的扩展，允许用户通过命令行界面查看和管理 GitHub 上的 Pull Requests 和 Issues。gh-dash 提供了丰富的配置选项，用户可以根据自己的需求定制仪表盘的显示内容和行为。

2. 项目快速启动

2.1 安装 GitHub CLI

首先，确保你已经安装了 GitHub CLI。你可以通过以下命令安装：

# macOS
brew install gh

# Ubuntu
sudo apt-get install gh

# Windows
choco install gh

2.2 安装 gh-dash 扩展

安装完 GitHub CLI 后，你可以通过以下命令安装 gh-dash 扩展：

gh extension install dlvhdr/gh-dash

2.3 配置 gh-dash

gh-dash 支持通过配置文件自定义仪表盘的显示内容。你可以在 ~/.config/gh-dash/config.yml 文件中创建配置文件，例如：

prSections:
  - title: My Pull Requests
    filters: is:open author:@me
    layout: author: hidden: true

issuesSections:
  - title: Created
    filters: is:open author:@me

2.4 启动 gh-dash

配置完成后，你可以通过以下命令启动 gh-dash：

gh dash

3. 应用案例和最佳实践

3.1 多项目管理

假设你同时在多个项目中工作，你可以为每个项目创建不同的配置文件，并通过 --config 参数指定不同的配置文件来切换仪表盘。

gh dash --config ~/config/gh-dash/work.yml
gh dash --config ~/config/gh-dash/personal.yml

3.2 自定义快捷键

gh-dash 允许用户自定义快捷键，例如你可以通过配置文件定义快捷键来快速查看某个 PR 的详细信息：

keybindings:
  prs:
    - key: d
      command: gh pr view [[PrNumber]]

4. 典型生态项目

4.1 GitHub CLI

gh-dash 是基于 GitHub CLI 开发的扩展，GitHub CLI 是一个强大的命令行工具，允许用户通过命令行与 GitHub 进行交互。

4.2 Nerd Fonts

为了确保 gh-dash 中的图标能够正确显示，建议安装并使用 Nerd Fonts。你可以从 Nerd Fonts 官网 下载并安装适合你的终端的字体。

4.3 Alacritty

gh-dash 的作者推荐使用 Alacritty 终端，并搭配 TokyoNight 主题和 Fira Code Nerd Font 字体，以获得最佳的视觉效果。

通过以上步骤，你可以快速上手并充分利用 gh-dash 来管理你的 GitHub 项目。

gh-dash A beautiful CLI dashboard for GitHub 🚀 项目地址: https://gitcode.com/gh_mirrors/gh/gh-dash