gh-run-watch(1)

gh-run-watch1

Watch a run until it completes, showing its progress

Usage

gh run watch <run-id> [flags]

Overview

Watch a run until it completes, showing its progress.

By default, all steps are displayed. The --compact option can be used to only show the relevant/failed steps.

This command does not support authenticating via fine grained PATs as it is not currently possible to create a PAT with the checks:read permission.

Options

--compact

Show only relevant/failed steps

--exit-status

Exit with non-zero status if run fails

-i, --interval <int> (default 3)

Refresh interval in seconds

Options inherited from parent commands

-R, --repo <[HOST/]OWNER/REPO>

Select another repository using the [HOST/]OWNER/REPO format

Exit status

0: Successful execution

1: Error

2: Command canceled

4: Authentication required

NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.

Examples

# Watch a run until it's done
$ gh run watch
# Watch a run in compact mode
$ gh run watch --compact
# Run some other command when the run is finished
$ gh run watch && notify-send 'run is done!'

Releases

3 releases since Debian 12 (Bookworm); the text changed 2 times.

  1. 12
  2. 13
  3. Arch

--compact since Arch Linux 2026-11-01.

--interval until Debian 12 (Bookworm); -i until Debian 12 (Bookworm).

From github-cli 2.102.1-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.