Scroll to navigation

GH-SEARCH-COMMITS(1) GitHub CLI manual GH-SEARCH-COMMITS(1)

NAME

gh-search-commits - Search for commits

SYNOPSIS

gh search commits [<query>] [flags]

DESCRIPTION

Search for commits on GitHub.

The command supports constructing queries using the GitHub search syntax, 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/searching-commits⟩

OPTIONS

Filter by author

Filter based on authored date

Filter on author email

Filter on author name

Filter by committer

Filter based on committed date

Filter on committer email

Filter on committer name

Filter by commit hash

Filter JSON output using a jq expression

Output JSON with the specified fields

Maximum number of commits to fetch

Filter on merge commits

Order of commits returned, ignored unless '--sort' flag is specified: {asc|desc}

Filter on repository owner

Filter by parent hash

Filter on repository

Sort fetched commits: {author-date|committer-date}

Format JSON output using a Go template; see "gh help formatting"

Filter by tree hash

Filter based on repository visibility: {public|private|internal}

Open the search query in the web browser

JSON FIELDS

author, commit, committer, id, parents, repository, sha, 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 commits matching set of keywords "readme" and "typo"
$ gh search commits readme typo
# search commits matching phrase "bug fix"
$ gh search commits "bug fix"
# search commits committed by user "monalisa"
$ gh search commits --committer=monalisa
# search commits authored by users with name "Jane Doe"
$ gh search commits --author-name="Jane Doe"
# search commits matching hash "8dd03144ffdc6c0d486d6b705f9c7fba871ee7c3"
$ gh search commits --hash=8dd03144ffdc6c0d486d6b705f9c7fba871ee7c3
# search commits authored before February 1st, 2022
$ gh search commits --author-date="<2022-02-01"

SEE ALSO

gh-search(1)

Dec 2024 GitHub CLI v2.63.0