Back to Gh Dash

Usage

docs/src/content/docs/companions/enhance/usage.mdx

4.23.2940 B
Original Source

To use enhance, follow these steps after you've [installed it][01]:

  1. Run

     gh enhance [<PR URL> | <PR number>] [flags]
    

    Examples:

    bash
     # look up checks via a full URL to a GitHub PR
     gh enhance https://github.com/dlvhdr/gh-dash/pull/767
    
     # look up checks via a PR number when inside a clone of dlvhdr/gh-dash
     # will look at checks of https://github.com/dlvhdr/gh-dash/pull/767
     gh enhance 767
    
  2. Press <kbd>?</kbd> for help.

Run gh enhance --help for more info:

Usage:
  gh enhance [<url> | <number>] [flags]

Flags:
      --debug         passing this flag will allow writing debug output to debug.log
      --flat          passing this flag will present checks as a flat list
  -h, --help          help for gh-enhance
  -R, --repo string   [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format
  -v, --version       version for gh-enhance