Sourcebot Cloud · Self Host · Demo

Docs · Report Bug · Feature Request · Changelog · Contact ·

Sourcebot uses Github Discussions for Support and Feature Requests.

About

Sourcebot is the open source Sourcegraph alternative. Index all your repos and branches across multiple code hosts (GitHub, GitLab, Gitea, or Gerrit) and search through them using a blazingly fast interface.

sourcebot_demo.mp4

Features

• 💻 One-command deployment: Get started instantly using Docker on your own machine.
• 🔍 Multi-repo search: Index and search through multiple public and private repositories and branches on GitHub, GitLab, Gitea, or Gerrit.
• ⚡Lightning fast performance: Built on top of the powerful Zoekt search engine.
• 🎨 Modern web app: Enjoy a sleek interface with features like syntax highlighting, light/dark mode, and vim-style navigation
• 📂 Full file visualization: Instantly view the entire file when selecting any search result.

You can try out our public hosted demo here!

Deploy Sourcebot

Sourcebot can be deployed in seconds using our official docker image. Visit our docs for more information.

1. Create a config

touch config.json
echo '{
    "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
    "connections": {
        // Comments are supported
        "starter-connection": {
            "type": "github",
            "repos": [
                "sourcebot-dev/sourcebot"
            ]
        }
    }
}' > config.json

2. Run the docker container

docker run -p 3000:3000 --pull=always --rm -v $(pwd):/data -e CONFIG_PATH=/data/config.json --name sourcebot ghcr.io/sourcebot-dev/sourcebot:latest

What does this command do?

• Pull and run the Sourcebot docker image from ghcr.io/sourcebot-dev/sourcebot:latest.
• Mount the current directory (-v $(pwd):/data) to allow Sourcebot to persist the .sourcebot cache.
• Clones sourcebot at HEAD into .sourcebot/github/sourcebot-dev/sourcebot.
• Indexes sourcebot into a .zoekt index file in .sourcebot/index/.
• Map port 3000 between your machine and the docker image.
• Starts the web server on port 3000.

3. Start searching at http://localhost:3000

To learn how to configure Sourcebot to index your own repos, please refer to our docs.

Note

Sourcebot collects anonymous usage data by default to help us improve the product. No sensitive data is collected, but if you'd like to disable this you can do so by setting the SOURCEBOT_TELEMETRY_DISABLED environment variable to false. Please refer to our telemetry docs for more information.

Build from source

Note

Building from source is only required if you'd like to contribute. If you'd just like to use Sourcebot, we recommend checking out our self-hosting docs.

If you'd like to build from source, please checkout the CONTRIBUTING.md file for more information.