Skip to content

Commit 85e6653

Browse files
committed
docs: incorporate README edits and enclose diagram cards
1 parent ccf0811 commit 85e6653

2 files changed

Lines changed: 8 additions & 49 deletions

File tree

‎.github/images/code-context.svg‎

Lines changed: 2 additions & 2 deletions
Loading

‎README.md‎

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a href="https://www.sourcebot.dev/changelog">Changelog</a>
1515
</p>
1616

17-
Sourcebot is a self-hosted code context layer for humans and AI agents. Index your repos in one place so you and your agents can search and navigate them. No need to clone each one locally.
17+
Sourcebot is a self-hosted code context layer for humans and AI agents. Index all your repos in one place so you and your agents can search and navigate them.
1818

1919
## Get started
2020

@@ -26,69 +26,28 @@ npx setup-sourcebot
2626

2727
You'll need Node.js (24 LTS recommended), Docker, and Docker Compose.
2828

29-
The wizard creates your config and Docker Compose files, then offers to start Sourcebot. It also lets you configure a language model provider for [Ask Sourcebot](https://docs.sourcebot.dev/docs/features/ask/ask-sourcebot). Once Sourcebot is running, open [localhost:3000](http://localhost:3000) to finish onboarding.
29+
This wizard walks you through indexing your repos, optionally configuring a language model provider (for [Ask Sourcebot](https://docs.sourcebot.dev/docs/features/ask/ask-sourcebot)), and then creates the config files for you and starts up Sourcebot.
3030

31-
For manual setup, use [Docker Compose](#docker-compose) or the [Helm chart](#kubernetes).
31+
For manual setup, use [Docker Compose](https://docs.sourcebot.dev/docs/deployment/docker-compose) or the [Helm chart](https://github.com/sourcebot-dev/sourcebot-helm-chart).
3232

3333
## Connect your agent
3434

35-
Your agent can use Sourcebot to search repos you haven't checked out locally. For example, it can find callers of an API in other services or read the implementation of a shared library.
35+
Your agent can use [Sourcebot MCP](https://docs.sourcebot.dev/docs/features/mcp-server) to search repos you haven't checked out locally. For example, it can find callers of an API in other services or read the implementation for dependencies that you don't have checked out locally.
3636

3737
![Repositories on GitHub, GitLab, Bitbucket, and Azure DevOps connected through Sourcebot to agents via API/MCP and humans via the web app](.github/images/code-context.svg)
3838

39-
The MCP server exposes code search, file reading, and symbol definitions and references for the repos you've indexed. Open **Settings → MCP** in Sourcebot to connect Claude Code, Codex, Cursor, or another MCP client. The [MCP docs](https://docs.sourcebot.dev/docs/features/mcp-server) cover setup and authentication for each client. There's also a [walkthrough on our website](https://www.sourcebot.dev/code-context).
39+
The MCP server exposes code search, file reading, and symbol definitions and references for the repos you've indexed. Open **Settings → MCP** in Sourcebot to connect Claude Code, Codex, Cursor, or another MCP client. The [MCP docs](https://docs.sourcebot.dev/docs/features/mcp-server) cover setup and authentication for each client.
4040

4141
Connect repos from GitHub, GitLab, Bitbucket, Azure DevOps, or local Git directories using the [connection guides](https://docs.sourcebot.dev/docs/connections/indexing-your-code). [Permission syncing](https://docs.sourcebot.dev/docs/features/permission-syncing) controls access based on your code host's repository permissions.
4242

4343
## Code Search and Ask Sourcebot
4444

4545
[Code Search](https://docs.sourcebot.dev/docs/features/search/code-search) lets you search across repos and branches in the web app. It supports regex, repo and language filters, and boolean queries.
4646

47-
[Ask Sourcebot](https://docs.sourcebot.dev/docs/features/ask/ask-sourcebot) answers questions about your codebase with inline citations you can open alongside the answer. It uses the same search and navigation tools as the MCP server, with a [language model provider you configure](https://docs.sourcebot.dev/docs/configuration/language-model-providers).
47+
[Ask Sourcebot](https://docs.sourcebot.dev/docs/features/ask/ask-sourcebot) answers questions about your codebase with inline citations you can open alongside the answer. It uses the same search and navigation tools as the MCP server, with a [language model provider you configure](https://docs.sourcebot.dev/docs/configuration/language-model-providers) (Bring Your Own Key).
4848

4949
Try both in the [public demo](https://app.sourcebot.dev). See [pricing](https://www.sourcebot.dev/pricing) for plan details.
5050

51-
## Deployment
52-
53-
### Docker Compose
54-
55-
The Docker image is `docker.sourcebot.dev/sourcebot-dev/sourcebot:latest`. The Compose file starts Sourcebot, PostgreSQL, and Redis.
56-
57-
1. In a new directory, download the Compose file:
58-
59-
```sh
60-
curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/docker-compose.yml
61-
```
62-
63-
2. Create `config.json` in the same directory. This example indexes Sourcebot's public repository:
64-
65-
```json
66-
{
67-
"$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
68-
"connections": {
69-
"github": {
70-
"type": "github",
71-
"repos": ["sourcebot-dev/sourcebot"]
72-
}
73-
}
74-
}
75-
```
76-
77-
The [config file reference](https://docs.sourcebot.dev/docs/configuration/config-file) covers repository selection, credentials, and language model providers.
78-
79-
3. Replace the default secrets and credentials marked `CHANGEME` in `docker-compose.yml` before starting. Keep the PostgreSQL password and `DATABASE_URL` in sync. See the [Docker Compose guide](https://docs.sourcebot.dev/docs/deployment/docker-compose) and [environment variable reference](https://docs.sourcebot.dev/docs/configuration/environment-variables).
80-
81-
4. Start Sourcebot:
82-
83-
```sh
84-
docker compose up -d
85-
```
86-
87-
Open [localhost:3000](http://localhost:3000) once the app is ready to finish onboarding.
88-
89-
### Kubernetes
90-
91-
Deploy with the [Sourcebot Helm chart](https://github.com/sourcebot-dev/sourcebot-helm-chart). Follow the chart's installation instructions and use the [sizing guide](https://docs.sourcebot.dev/docs/deployment/sizing-guide) to choose CPU and memory allocations.
9251

9352
## Feedback
9453

0 commit comments

Comments
 (0)