GitHub - sourcebot-dev/sourcebot: Sourcebot is a self-hosted tool that helps humans and agents understand your codebase.

Sourcebot is a self-hosted tool that helps you understand your codebase.

Ask Sourcebot: Ask questions about your codebase and have Sourcebot provide detailed answers grounded with inline citations.
Code search: Search and navigate across all your repos and branches, no matter where they’re hosted.

Try it out in our public demo!

hero_demo.mp4

Features

Ask Sourcebot gives you the ability to ask complex questions about your codebase in natural language.

It uses Sourcebot's existing code search and navigation tools to allow reasoning models to search your code, follow code nav references, and provide an answer that's rich with inline citations and navigable code snippets.

ask_sourcebot.mp4

Code Search

Search across all your repos/branches across any code host platform. Blazingly fast, and supports regular expressions, repo/language search filters, boolean logic, and more.

sourcebot_code_search.mp4

Code Navigation

IDE-level code navigation (goto definition and find references) across all your repos.

code_nav.mp4

Built-in File Explorer

Explore every file across all of your repos. Modern UI with syntax highlighting, file tree, code navigation, etc.

file_explorer.mp4

Deploy Sourcebot

Sourcebot can be deployed in seconds using Docker Compose. Visit our docs for more information.

Download the docker-compose.yml file

curl -o docker-compose.yml https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/docker-compose.yml

In the same directory as the docker-compose.yml file, create a configuration file. The configuration file is a JSON file that configures Sourcebot's behaviour, including what repositories to index, language model providers, auth providers, and more.

echo '{
    "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
    // Comments are supported.
    // This config creates a single connection to GitHub.com that
    // indexes the Sourcebot repository
    "connections": {
        "starter-connection": {
            "type": "github",
            "repos": [
                "sourcebot-dev/sourcebot"
            ]
        }
    }
}' > config.json

Update the secrets in the docker-compose.yml and then run Sourcebot using:

Visit http://localhost:3000 to start using Sourcebot

To configure Sourcebot (index your own repos, connect your LLMs, etc), check out 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 true. 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.