User documentation

Welcome to Sourcegraph! As a developer, you can use Sourcegraph to get help while writing and reviewing code.

All features:

What is Sourcegraph?

Sourcegraph is a code search and intelligence tool for developers. It lets you search and explore all of your organization’s code on the web, with integrations into your existing tools.

What does Sourcegraph do?

Sourcegraph’s main features are:

  • Code search: fast, up-to-date, and scalable, with regexp support on any branch or commit without an indexing delay (and diff search)
  • Code intelligence: jump-to-definition, find references, and other smart, IDE-like code browsing features on any branch, commit, or PR/code review
  • Easy and secure self-hosted installation (your code never touches our servers)
  • Integrations with code hosts, code review tools, editors, web browsers, etc.

What do I use Sourcegraph for?

Sourcegraph helps you:

  • Find example code
  • Explore/read code (including during a code review)
  • Debug issues
  • Locate a specific piece of code
  • Determine the impact of changes

Sourcegraph makes it faster and easier to perform these tasks, for you and everyone else at your organization.

Who should use Sourcegraph?

All developers, except:

  • Sourcegraph is more useful to developers working with larger codebases or teams (15+ developers).
  • If you rarely search, read, or review code, you probably won’t find Sourcegraph useful. (But you should start reading and reviewing more code!)

Who else uses Sourcegraph?

In addition to the companies listed on about.sourcegraph.com, many large technology companies with 500-3,000+ engineers use Sourcegraph internally.

Also, both Facebook and Google provide an in-house Sourcegraph-like code search and intelligence tool to their employees. A published research paper from Google and a Google developer survey showed that 98% of developers surveyed consider their Sourcegraph-like internal tool to be critical. Developers use it on average for 5.3 sessions each day. (Facebook’s and Google’s in-house tools are not available to other companies; use Sourcegraph instead.)

How do I start using Sourcegraph?

  1. Install Sourcegraph inside your organization on your internal code, if nobody else has yet
  2. Install and configure the web browser code host integrations (recommended)
  3. Start searching and browsing code on Sourcegraph by visiting the URL of your organization’s internal Sourcegraph instance

You can also try Sourcegraph.com, which is a public instance of Sourcegraph for use on open-source code only.


Code intelligence

Sourcegraph gives your development team cross-repository IDE-like features on your code:

  • Hover tooltips
  • Go-to-definition
  • Find references
  • Symbol search

Sourcegraph gives you code intelligence in:

  • code files in Sourcegraph’s web UI

Hover tooltip

GitHub pull request integration

GitHub file integration

Read the code intelligence documentation to learn more and to set it up.


Sourcegraph code search is fast, works across all your repositories at any commit, and has no indexing delay. Code search also includes advanced features, including:

  • Powerful, flexible query syntax
  • Commit diff search
  • Commit message search
  • Custom search scopes
  • Saved search monitoring

Read the code search documentation to learn more and discover the full feature set.


Integrations

Sourcegraph allows you to get code intelligence and code search on code files and code review diffs in your code host and review tool. See our integrations documentation to set up Sourcegraph with your tools and roll it out to your entire team.