Sourcebot is a self-hosted tool that helps you understand your codebase.
Find a file
2025-07-31 17:50:31 -07:00
.cursor/rules V4 (#311) 2025-05-28 16:08:42 -07:00
.github switch demo to deploy on main 2025-07-23 11:33:25 -07:00
.vscode Display name improvements (#259) 2025-04-02 17:50:48 -07:00
.yarn/releases v3 effort (#158) 2025-03-31 22:34:42 -07:00
configs update example configs to use v3 schema 2025-04-01 10:26:46 -07:00
docs chore(readme): Update README with new videos (#410) 2025-07-29 17:47:49 -07:00
ee Search contexts (#273) 2025-04-24 22:28:13 -07:00
packages chore(ask_sb): Bump Vercel SDK to official V5 release 🎉 (#417) 2025-07-31 17:50:31 -07:00
schemas feat(search_contexts): Add ability to include/exclude connections in search contexts (#399) 2025-07-27 10:11:58 -07:00
vendor feat: Generic git host support (local & remote) (#307) 2025-05-15 13:42:58 -07:00
.dockerignore v3 effort (#158) 2025-03-31 22:34:42 -07:00
.env.development Adds support for encrypted license keys (#335) 2025-06-05 22:18:52 -07:00
.gitignore v3 effort (#158) 2025-03-31 22:34:42 -07:00
.gitmodules update zoekt version 2025-04-01 10:38:50 -07:00
.yarnrc.yml v3 effort (#158) 2025-03-31 22:34:42 -07:00
_typos.toml chore: Misc typos (UI, docs, code...), Makefile PATH with spaces (#369) 2025-07-16 11:59:01 -07:00
CHANGELOG.md chore(ask_sb): Bump Vercel SDK to official V5 release 🎉 (#417) 2025-07-31 17:50:31 -07:00
CONTRIBUTING.md chore: Misc typos (UI, docs, code...), Makefile PATH with spaces (#369) 2025-07-16 11:59:01 -07:00
default-config.json Config format V2 (#42) 2024-10-17 16:31:18 -04:00
demo-site-config.json Add anonymous access option to core (#385) 2025-07-19 14:04:41 -07:00
docker-compose-dev.yml [dev + copy button] add / update local dev w/docker compose; add copy button to the right of filenames (#328) 2025-06-03 08:52:59 -07:00
Dockerfile Add missing ARG statements in Dockerfile 2025-07-23 12:09:02 -07:00
entrypoint.sh Only create DB directory if using embedded DB (#267) 2025-04-10 21:39:31 -06:00
fly.toml Use main for demo site 2024-10-30 09:35:06 -07:00
grafana.alloy v3 effort (#158) 2025-03-31 22:34:42 -07:00
LICENSE.md make the license a markdown file 2025-07-20 11:49:42 -07:00
Makefile chore: Misc typos (UI, docs, code...), Makefile PATH with spaces (#369) 2025-07-16 11:59:01 -07:00
package.json feat: Ask Sourcebot (#392) 2025-07-23 11:25:15 -07:00
prefix-output.sh Config format V2 (#42) 2024-10-17 16:31:18 -04:00
public.pem Adds support for encrypted license keys (#335) 2025-06-05 22:18:52 -07:00
README.md fix video links in README 2025-07-30 00:03:58 -07:00
supervisord.conf Review Agent (#298) 2025-05-12 12:10:01 -07:00
yarn.lock chore(ask_sb): Bump Vercel SDK to official V5 release 🎉 (#417) 2025-07-31 17:50:31 -07:00


Sourcebot uses Github Discussions for Support and Feature Requests.

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 theyre hosted.

Try it out in our public demo!

https://github.com/user-attachments/assets/ed66a622-e38f-4947-a531-86df1e1e0218

Features

Sourcebot Features

Ask Sourcebot

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.

https://github.com/user-attachments/assets/8212cd16-683f-468f-8ea5-67455c0931e2

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.

https://github.com/user-attachments/assets/3b381452-d329-4949-b6f2-2fc38952e481

Code Navigation

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

https://github.com/user-attachments/assets/e2da2829-71cc-40af-98b4-7ba52e945530

Built-in File Explorer

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

https://github.com/user-attachments/assets/31ec0669-707d-4e03-b511-1bc33d44197a

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
  1. 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.

  1. 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.