ghpr comment list

NAME

ghpr comment list - list comment threads on a pull request

SYNOPSIS

ghpr comment list <pr> [options]

DESCRIPTION

List all review comment threads on a pull request. By default, shows all threads; use --unresolved to filter to only unresolved threads. Supports multiple output formats and can write each thread to a separate file for batch processing.

ARGUMENTS

Argument	Required	Description
`<pr>`	Yes	Pull request number

OPTIONS

Option	Default	Description
`-t, --token <token>`	-	GitHub personal access token
`-r, --repo <owner/repo>`	-	Repository in owner/repo format
`--unresolved`	`false`	Show only unresolved threads
`-f, --format <format>`	`text`	Output format: `text`, `json`, `markdown`
`--write-each <directory>`	-	Write each thread to a separate JSON file

EXIT CODES

Code	Meaning
`0`	Success
`3`	Error (API error, auth error, PR not found)

OUTPUT

Each thread includes:

Thread ID - PRRT_ prefixed ID for use with comment resolve
Comment ID - Numeric ID for use with comment reply
Author - GitHub username of the commenter
Body - Comment text
Resolution status - Whether the thread is resolved
Outdated flag - Whether the comment is on outdated code
File path and line - Location in the code (if applicable)

Write-Each Mode

When using --write-each:

Creates the directory if it doesn’t exist
Generates one JSON file per thread: {commentId}.json
Files contain full thread data including all metadata
Will not overwrite existing files
Only writes threads that have comments
Incompatible with --format json or --format markdown

EXAMPLES

List All Comments

ghpr comment list 123

List Only Unresolved Comments

ghpr comment list 123 --unresolved

JSON Output

ghpr comment list 123 --format json

Markdown Output

ghpr comment list 123 -f markdown

Write Threads to Directory

ghpr comment list 123 --unresolved --write-each ./review-threads

Process Unresolved Comments with jq

ghpr comment list 123 --unresolved --format json | jq -r '.[].threadId'

Batch Process Comments

ghpr comment list 123 --unresolved --write-each ./review-threads

for file in ./review-threads/*.json; do
  THREAD_ID=$(jq -r '.encodedThreadId' "$file")
  COMMENT_ID=$(jq -r '.comments[0].databaseId' "$file")

  # Process each comment...
  ghpr comment reply 123 $COMMENT_ID "Fixed!"
  ghpr comment resolve 123 $THREAD_ID
done