Back to Gh Dash

Installation

docs/src/content/docs/getting-started/index.mdx

4.23.21.4 KB
Original Source

Get started using dash to review and manage your GitHub work items.

  1. Install the gh CLI

    bash
    brew install gh # e.g. if on macOS
    

    Or, see the installation instructions for other platforms.

  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. Then, select that font as your font for your terminal of choice.

    bash
     brew install --cask font-fira-code-nerd-font
    

<details> <summary>How do I get these exact colors and font?</summary> The screenshots in this documentation use [Ghostty][n01] with the [tokyonight theme][n02] and the [Fira Code][n03] Nerd Font. For the full setup, see [these dotfiles][n04]. </details>

Manual Steps

If you want to install this extension manually, follow these steps:

  1. Clone the repo

    bash
    # git
    git clone https://github.com/dlvhdr/gh-dash
    
    # GitHub CLI
    gh repo clone dlvhdr/gh-dash
    
  2. cd into it

    bash
    cd gh-dash
    
  3. Install it locally

    bash
    gh extension install .