Back to Gh Dash

Installation

docs/src/content/docs/companions/enhance/getting-started.mdx

4.23.21.9 KB
Original Source

import { Aside } from "@astrojs/starlight/components";

Get started using ENHANCE to manage your PRs GitHub Actions.

  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
    # if you're *not* in the insiders program
    gh extension install dlvhdr/gh-enhance
    
    # if you are in the insiders program
    gh extension install dlvhdr-insiders/gh-enhance
    
    
  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
  • If you're not in the insiders program:

    bash
    # Git
    git clone https://github.com/dlvhdr/gh-enhance
    
    # or with the GitHub CLI
    gh repo clone dlvhdr/gh-enhance
    
  • If you are in the insiders program:

    bash
      # Git
      git clone https://github.com/dlvhdr-insiders/gh-enhance
    
      # or with the GitHub CLI
      gh repo clone dlvhdr-insiders/gh-enhance
    
  1. cd into it

    bash
    cd gh-enhance
    
  2. Install it locally

    bash
    gh extension install .