Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
GH-SEARCH-PRS(1)	       GitHub CLI manual	      GH-SEARCH-PRS(1)

NAME
       gh-search-prs - Search for pull requests

SYNOPSIS
       gh search prs [<query>] [flags]

DESCRIPTION
       Search for pull requests	on GitHub.

       The  command supports constructing queries using	the GitHub search syn-
       tax, using the parameter	and qualifier flags, or	a combination  of  the
       two.

       GitHub search syntax is documented at:

       <https://docs.github.com/search-github/searching-on-github/search-
       ing-issues-and-pull-requests>

OPTIONS
       --app <string>
	      Filter by	GitHub App author

       --archived
	      Filter based on the repository archived state {true|false}

       --assignee <string>
	      Filter by	assignee

       --author	<string>
	      Filter by	author

       -B, --base <string>
	      Filter on	base branch name

       --checks	<string>
	      Filter based on status of	the checks: {pending|success|failure}

       --closed	<date>
	      Filter on	closed at date

       --commenter <user>
	      Filter based on comments by user

       --comments <number>
	      Filter on	number of comments

       --created <date>
	      Filter based on created at date

       --draft
	      Filter based on draft state

       -H, --head <string>
	      Filter on	head branch name

       --interactions <number>
	      Filter on	number of reactions and	comments

       --involves <user>
	      Filter based on involvement of user

       -q, --jq	<expression>
	      Filter JSON output using a jq expression

       --json <fields>
	      Output JSON with the specified fields

       --label <strings>
	      Filter on	label

       --language <string>
	      Filter based on the coding language

       -L, --limit <int> (default 30)
	      Maximum number of	results	to fetch

       --locked
	      Filter on	locked conversation status

       --match <strings>
	      Restrict	search	to  specific  field of issue: {title|body|com-
	      ments}

       --mentions <user>
	      Filter based on user mentions

       --merged
	      Filter based on merged state

       --merged-at <date>
	      Filter on	merged at date

       --milestone <title>
	      Filter by	milestone title

       --no-assignee
	      Filter on	missing	assignee

       --no-label
	      Filter on	missing	label

       --no-milestone
	      Filter on	missing	milestone

       --no-project
	      Filter on	missing	project

       --order <string>	(default "desc")
	      Order of results returned, ignored unless	'--sort' flag is spec-
	      ified: {asc|desc}

       --owner <strings>
	      Filter on	repository owner

       --project <owner/number>
	      Filter on	project	board owner/number

       --reactions <number>
	      Filter on	number of reactions

       -R, --repo <strings>
	      Filter on	repository

       --review	<string>
	      Filter	based	 on    review	 status:    {none|required|ap-
	      proved|changes_requested}

       --review-requested <user>
	      Filter on	user or	team requested to review

       --reviewed-by <user>
	      Filter on	user who reviewed

       --sort <string> (default	"best-match")
	      Sort   fetched  results:	{comments|reactions|reactions-+1|reac-
	      tions--1|reactions-smile|reactions-thinking_face|reactions-
	      heart|reactions-tada|interactions|created|updated}

       --state <string>
	      Filter based on state: {open|closed}

       --team-mentions <string>
	      Filter based on team mentions

       -t, --template <string>
	      Format JSON output using a Go template; see "gh help formatting"

       --updated <date>
	      Filter on	last updated at	date

       --visibility <strings>
	      Filter based on repository visibility: {public|private|internal}

       -w, --web
	      Open the search query in the web browser

JSON FIELDS
       assignees, author, authorAssociation,  body,  closedAt,	commentsCount,
       createdAt, id, isDraft, isLocked, isPullRequest,	labels,	number,	repos-
       itory, state, title, updatedAt, url

EXIT CODES
       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.

EXAMPLE
       # search	pull requests matching set of keywords "fix" and "bug"
       $ gh search prs fix bug

       # search	draft pull requests in cli repository
       $ gh search prs --repo=cli/cli --draft

       # search	open pull requests requesting your review
       $ gh search prs --review-requested=@me --state=open

       # search	merged pull requests assigned to yourself
       $ gh search prs --assignee=@me --merged

       # search	pull requests with numerous reactions
       $ gh search prs --reactions=">100"

       # search	pull requests without label "bug"
       $ gh search prs -- -label:bug

       # search	pull requests only from	un-archived repositories (default is all repositories)
       $ gh search prs --owner github --archived=false

SEE ALSO
       gh-search(1)

				   Apr 2025		      GH-SEARCH-PRS(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gh-search-prs&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help