Sourcegraph browser extension

The open-source Sourcegraph browser extension adds code intelligence to files and diffs on GitHub, GitHub Enterprise, GitLab, Phabricator, and Bitbucket Server.

Install Sourcegraph for Chrome

Install Sourcegraph for Firefox

Sourcegraph browser extension

Features

Code intelligence

When you hover your mouse over code in files, diffs, pull requests, etc., the Sourcegraph extension displays a tooltip with:

  • Documentation and the type signature for the hovered token
  • Go to definition button
  • Find references button

Search shortcut in location bar

The Sourcegraph extension adds a search engine shortcut to your web browser that performs a search on your Sourcegraph instance. After you’ve installed it (see above), use the search shortcut it provides to perform a search:

  1. In the Chrome or Firefox location bar, type src Space.
  2. Start typing your search query.
  3. Select an instant search suggestion or press Enter to see all results.

To install this search engine shortcut manually, and for more information, see “Browser search engine shortcuts”.

Configuring the Sourcegraph instance to use

By default, the browser extension communicates with Sourcegraph.com, which has only public code.

To use the browser extension with a different Sourcegraph instance:

  1. Click the Sourcegraph extension icon in the browser toolbar to open the settings page.
  2. Click Update and enter the URL of a Sourcegraph instance (such as https://sourcegraph.example.com or https://sourcegraph.com).
  3. Click Save.
{
  // ...
  "corsOrigin":
    "https://github.example.com https://gitlab.example.com https://bitbucket.example.org https://phabricator.example.com"
  // ...
}

Troubleshooting

The most common problem is:

No code intelligence or buttons (“View repository”, “View file”, etc.) are displayed on the code host.

Try the following:

  1. Click the Sourcegraph extension icon in the browser toolbar to open the settings page.
    • Ensure that the Sourcegraph URL is correct. It must point to your own Sourcegraph instance to work on private code.
    • Check whether any permissions must be granted. If so, the settings page will display an alert with a Grant permissions button.
    • Confirm with your Sourcegraph instance’s site admin that the site config corsOrigin property contains the URL of the external site on which you are trying to use the browser extension.