Sourcegraph OSS edition is a fast, open-source, fully-featured code search and navigation engine. Enterprise editions are available.

Features

• Fast global code search with a hybrid backend that combines a trigram index with in-memory streaming
• Code intelligence for many languages via the Language Server Protocol
• Enhances GitHub, GitLab, Phabricator, and other code hosts and code review tools via the Sourcegraph browser extension
• Integration with third-party developer tools via the Sourcegraph extension API

Try it yourself

• Try out the public instance on any open-source repository at sourcegraph.com.
• Install the free and open-source browser extension.
• Spin up your own instance with the quickstart installation guide.
• File feature requests and bug reports in our issue tracker.
• Visit about.sourcegraph.com for more information about product features.

Development

Prerequisites

• Git
• Go (1.13 or later)
• Docker
• PostgreSQL (v11 or higher)
• Node.js (version 8 or 10)
• Redis
• Yarn
• Nginx

For a detailed guide to installing prerequisites, see these instructions.

Installation

Prebuilt Docker images are the fastest way to use Sourcegraph Enterprise. See the quickstart installation guide.

To use Sourcegraph OSS:

1. Ensure Docker is running

2. Initialize the PostgreSQL database

3. Configure the HTTPS reverse proxy

4. Start the development server

   ./dev/start.sh
   

Sourcegraph should now be running at https://sourcegraph.test:3443.

For detailed instructions and troubleshooting, see the local development documentation.

Documentation

The doc directory has additional documentation for developing and understanding Sourcegraph:

• Project FAQ
• Architecture: high-level architecture
• Database setup: database setup and best practices
• General style guide
• Go style guide
• Documentation style guide
• GraphQL API: useful tips when modifying the GraphQL API
• Contributing

License

Sourcegraph OSS is available freely under the Apache 2 license. Sourcegraph OSS comprises all files in this repository except those in the enterprise/ and web/src/enterprise directories.

All files in the enterprise/ and web/src/enterprise/ directories are subject to the Sourcegraph Enterprise license.