|
Some checks are pending
Publish to ghcr / build (linux/arm64, blacksmith-8vcpu-ubuntu-2204-arm) (push) Waiting to run
Publish to ghcr / build (linux/amd64, blacksmith-4vcpu-ubuntu-2404) (push) Waiting to run
Publish to ghcr / merge (push) Blocked by required conditions
Update Roadmap Released / update (push) Waiting to run
|
||
|---|---|---|
| .cursor/rules | ||
| .github | ||
| .vscode | ||
| .yarn/releases | ||
| configs | ||
| docs | ||
| ee | ||
| packages | ||
| schemas | ||
| vendor | ||
| .dockerignore | ||
| .env.development | ||
| .gitignore | ||
| .gitmodules | ||
| .yarnrc.yml | ||
| _typos.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| docker-compose-dev.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| entrypoint.sh | ||
| fly.toml | ||
| grafana.alloy | ||
| LICENSE.md | ||
| Makefile | ||
| package.json | ||
| prefix-output.sh | ||
| public.pem | ||
| README.md | ||
| supervisord.conf | ||
| yarn.lock | ||
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!
https://github.com/user-attachments/assets/ed66a622-e38f-4947-a531-86df1e1e0218
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
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.
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 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.ymlfile, 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.
touch config.json
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.ymland then run Sourcebot using:
docker compose up
- Visit
http://localhost:3000to 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_DISABLEDenvironment variable totrue. 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.