Sourcegraph is a universal code search tool, enabling you to search across both open source and your own private code repositories. Code search can help you onboard onto new codebases, contribute to open source, find bugs and error messages, understand dependency libraries, and more.
By default, Sourcegraph lets you search globally, providing you with results from all the repositories you have access to. On Sourcegraph cloud, this includes all currently indexed open source repositories. The
repo command lets you dial down to the single repository level.
repo keyword lets you search a specific repository in your organization or on the web.
repo:^github\.com/ORGANIZATION will return all repositories in a given organization, where
ORGANIZATION can be
sourcegraph, for example.
repo keyword contextualizes the searches you perform on Sourcegraph.
When searching a repository, command chaining can be used to return more specific results depending on the expected results.
Search for a repository that contains a file
If you are searching for a file in a repository, use
For example, when searching for the
package.json file in a project, this search query will return the file.
A similar example that uses the content query to search for files is shown below.
This query returns repositories that contain a
package.json file and has content written in TypeScript.
Search for a repository that contains some content
Suppose you are searching for some content in a repository, such as a library. Use
repo:[repo-path] repo.contains.content([content]) repo:[repo-path] repo.contains.content([regular-pattern])
We can search for the
mdi-react library in Sourcegraph, for example:
The above query returns repos that have
mdi-react among its contents.
lang when searching code to narrow the scope of your search to one programming language.
We can search for results within the C++ or Python programming languages.
By default, searches are case insensitive.
Prepending a hyphen can exclude results from a particular programming language.
To exclude Java, you can perform the following search.
Narrowing your search scope down to specific languages can ensure that you find the code that is most relevant to your needs.
If you are searching for code committed before or after a time period, you will use
Sometimes the time period can be literal, like
3 months ago,
february 10 2021 or have actual dates in the format
before:last week after:february 10 2021 before:02/01/2019
To search between dates, keywords like
and can be combined with
after to return dates within a given period.
Time-based search is usually used along with other search commands to further narrow down search results.
after only work in conjunction when combined with
archived keyword will bring up those results from repositories that have been archived.
archived:[yes/only] archived:yes archived:only
We can surface only archived repositories within the Sourcegraph organization with the following query.
This can help us understand past decisions made within a given codebase.
no with the
case search query to specify if the search should be case sensitive or not. By default, searches are case insensitive.
case:[yes/no] case:yes case:no
Suppose you would like to check to align the style of a given codebase to help you bring all function calls in Python to be consistent with the PEP 8 guidance. You can use Sourcegraph to understand which functions are using camelCase rather than lowercase names with underscores between words (also called snake_case).
If you would like to find all declared functions that use camelCase, you can try combining this query with regular expressions.
Types define the scope of code search. A search scope consists of commits, diffs, symbols, repos, paths and files. It is typically used alongside other search commands to further narrow search results.
Here is an example to show us time-based commits on the Sourcegraph repo.
type scope can use the following commands, which will restrict search to the following:
commit— commits to a repository
diff— show diffs, or changes, within a repository *
repo— repositories available to you
files— returns files *
symbol— returns files that contain names or keywords in a library.
Searching by type can help you find exactly what you need in a codebase by narrowing down the scope of your search.
If a commit message is known, it can be helpful to use the
message keyword to bring up relevant commits.
We can find all commit messages with “fix” in the
sourcegraph/sourcegraph repository by searching the following.
Note that the message keyword only works for
author keyword returns code search results that were created by a user. This keyword only works for
Adding a hyphen in front of the
author keyword omits code content created by a given author.
Search for all code diffs by the Renovate app within our Sourcegraph repository.
You can also search by
committer:git-email with the same
Sourcegraph returns pages filled with search results. To stop searching after a given number of results are returned, use the
count:5 would return the first 5 results of a given query.
all option returns all results from a search.
count keyword may also be used to return more results, not just fewer results. This can enable you to display more than the default 500 results that are returned.
fork keyword restricts the scope of search results to either include, exclude, or return only forks of a given repository.
yes option includes forked repositories, the
no option omits the results from forks, and the
only option searches only forked repositories.
One use case for searching forked repositories is looking for how users personalize open source libraries.
To set the duration before a search times out, you’ll use the
timeout keyword. Time units that can be used include nanoseconds (
ns), microseconds (
µs) , milliseconds (
ms), seconds (
s) or minutes (
This is useful when searching many repositories at the same time to give search more time to return useful results. By default, timeout is 10 seconds, however, when using the
timeout command, timeouts can be set to over a minute. When this scope is provided, search is given more time to complete.
Alternatively, if you are receiving too many results, you can decrease the time of search.
Restricting search by codebase visibility is done with the
visibility command. You can restrict search to public or private repositories.
This is useful if you want the results of a search to be explicitly narrowed down to repositories that are private and accessible to you or repositories that are public.
Except when explicitly set, all searches return results from both public and private repositories accessible to you.
When logged into Sourcegraph, you can change your context to your username and then run the following command to show all of your available private repositories.
This can allow you to search across the code that is private to only you. Please note that searching private code on Sourcegraph cloud is currently in Public Beta.
To learn more about how to search effectively with Sourcegraph, you can read through our Sourcegraph search series: