Scroll to navigation

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

NAME

gh-search-code - Search within code

SYNOPSIS

gh search code <query> [flags]

DESCRIPTION

Search within code in GitHub repositories.

The search syntax is documented at:

⟨https://docs.github.com/search-github/searching-on-github/searching-code⟩

Note that these search results are powered by what is now a legacy GitHub code search engine. The results might not match what is seen on github.com, and new features like regex search are not yet available via the GitHub API.

OPTIONS

Filter on file extension

Filter on filename

Filter JSON output using a jq expression

Output JSON with the specified fields

Filter results by language

Maximum number of code results to fetch

Restrict search to file contents or file path: {file|path}

Filter on owner

Filter on repository

Filter on size range, in kilobytes

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

Open the search query in the web browser

EXAMPLE

# search code matching "react" and "lifecycle"
$ gh search code react lifecycle
# search code matching "error handling" 
$ gh search code "error handling"
	
# search code matching "deque" in Python files
$ gh search code deque --language=python
# search code matching "cli" in repositories owned by microsoft organization
$ gh search code cli --owner=microsoft
# search code matching "panic" in the GitHub CLI repository
$ gh search code panic --repo cli/cli
# search code matching keyword "lint" in package.json files
$ gh search code lint --filename package.json

SEE ALSO

gh-search(1)

Apr 2024 GitHub CLI v2.48.0