diff --git a/README.md b/README.md
index 62951d430..7dcd9d6fb 100644
--- a/README.md
+++ b/README.md
@@ -23,121 +23,116 @@ Sourcebot is a fast code indexing and search tool for your codebases. It is buil
-# Getting Started
+## Features
+- 💻 **One-command deployment**: Get started instantly using Docker on your own machine.
+- 🔍 **Multi-repo search**: Effortlessly index and search through multiple public and private repositories (GitHub, GitLab, BitBucket).
+- ⚡**Lightning fast performance**: Built on top of the powerful [Zoekt](https://github.com/sourcegraph/zoekt) search engine.
+- 📂 **Full file visualization**: Instantly view the entire file when selecting any search result.
+- 🎨 **Modern web application**: Enjoy a sleek interface with features like syntax highlighting, light/dark mode, and vim-style navigation
-## Using Docker
+You can try out our public hosted demo [here](https://demo.sourcebot.dev/)!
+# Getting Started
-0. Install Docker
+Get started with a single docker command:
-1. Create a `config.json` file and list the repositories you want to index. The JSON schema [index.json](./schemas/index.json) defines the structure of the config file and the available options. For example, if we want to index Sourcebot on its own code, we could use the following config found in `sample-config.json`:
+```
+docker run -p 3000:3000 --rm --name sourcebot ghcr.io/taqlaai/sourcebot:main
+```
- ```json
- {
- "$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
- "Configs": [
- {
- "Type": "github",
- "GitHubOrg": "TaqlaAI",
- "Name": "^sourcebot$"
- }
- ]
- }
- ```
+Navigate to `localhost:3000` to start searching the Sourcebot repo. Want to search your own repos? Checkout how to [configure Sourcebot](#configuring-sourcebot).
-Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](./schemas/index.json) for a full list of available options.
+
+What does this command do?
-2. Create a Personal Access Token (PAT) to authenticate with a code host(s):
+- Pull and run the Sourcebot docker image from [ghcr.io/taqlaai/sourcebot:main](https://github.com/taqlaai/sourcebot/pkgs/container/sourcebot). You'll need to make sure you have [docker installed](https://docs.docker.com/get-started/get-docker/) to do this.
+- Sourcebot will index itself to prepare for your search request.
+- Map port 3000 between your machine and the docker image (`-p 3000:3000`).
+
-
-
-
-
-
-
-
- GitHub
-
- Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you're only indexing public repositories select the `public_repo` scope; otherwise, select the `repo` scope.
+## Configuring Sourcebot
- You'll need to pass this PAT each time you run Sourcebot, so we recommend adding it as an environment variable. In this guide, we'll add the Github PAT as an environment variable called `GITHUB_TOKEN`:
- ```sh
- export GITHUB_TOKEN=
- ```
+Sourcebot supports indexing and searching through public and private repositories hosted on
+
+
+
+ GitHub,
+GitLab, and
+ BitBucket. This section will guide you through configuring the repositories that Sourcebot indexes.
- If you'd like to persist this environment variable across shell sessions, please add this line to your shell config file (ex. `~/.bashrc`, `~/.bash_profile`, etc)
-
+1. Create a new folder on your machine that stores your configs and `.sourcebot` cache, and navigate into it:
+```
+mkdir sourcebot_workspace
+cd sourcebot_workspace
+```
-
+2. Create a new config following the [configuration schema](https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json) to specify which repositories Sourcebot should index. For example to index Sourcebot itself:
-
- GitLab
-
- TODO
+```
+touch my_config.json
+echo `{
+ "$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
+ "Configs": [
+ {
+ "Type": "github",
+ "GitHubOrg": "TaqlaAI",
+ "Name": "sourcebot"
+ }
+ ]
+}` > my_config.json
+```
-
+3. Run Sourcebot and point it to the new config you created:
-
- BitBucket
+```
+docker run -p 3000:3000 --rm --name sourcebot -e CONFIG_PATH=./my_config.json -v $(pwd):/data ghcr.io/taqlaai/sourcebot:main
+```
- TODO
+This command will also mount the current directory (`-v $(pwd):/data`) to allow Sourcebot to persist the `.sourcebot` cache.
-
-
+### (Optional) Provide an access token to index private repositories
+In order to allow Sourcebot to index your private repositories, you must provide it with an access token.
-3. Launch the latest image from the [ghcr registry](https://github.com/TaqlaAI/sourcebot/pkgs/container/sourcebot):
+
+
+
+
+
+
+ GitHub
+
-
-
-
-
-
-
-
- GitHub
-
+Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new) and make sure you select the `repo` scope.
- Run the `sourcebot` docker image, passing in the Github PAT you generated in the previous step as an environment variable called `GITHUB_TOKEN`:
- ```sh
- docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITHUB_TOKEN=$GITHUB_TOKEN ghcr.io/taqlaai/sourcebot:main
- ```
-
+You'll need to pass this PAT each time you run Sourcebot by setting the GITHUB_TOKEN environment variable:
-
- GitLab
+
+
+ BitBucket
- Two things should happen: (1) a `.sourcebot` directory will be created containing the mirror repositories and indexes, and (2) you will see output similar to:
+TODO
- ```sh
- INFO spawned: 'node-server' with pid 10
- INFO spawned: 'zoekt-indexserver' with pid 11
- INFO spawned: 'zoekt-webserver' with pid 12
- run [zoekt-mirror-github -dest /data/.sourcebot/repos -delete -org ]
- ...
- INFO success: node-server entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
- INFO success: zoekt-indexserver entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
- INFO success: zoekt-webserver entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
- ```
+
+
- zoekt will now index your repositories (at `HEAD`). By default, it will re-index existing repositories every hour, and discover new repositories every 24 hours.
-4. Go to `http://localhost:3000` - once an index has been created, you can start searching.
+## Build from source
+>[!NOTE]
+>You don't need to build Sourcebot in order to use it! If you'd just like to use Sourcebot, please read [how to configure Sourcebot](#configuring-sourcebot).
-## Building Sourcebot
+If you'd like to make changes to Sourcebot you'll need to build from source:
1. Install go and NodeJS. Note that a NodeJS version of at least `21.1.0` is required.
@@ -167,7 +162,7 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules`
{
"Type": "github",
"GitHubOrg": "TaqlaAI",
- "Name": "^sourcebot$"
+ "Name": "sourcebot"
}
]
}
@@ -216,14 +211,15 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules`
## Telemetry
-By default, Sourcebot collects anonymized usage data through [PostHog](https://posthog.com/) to help us improve the performance and reliability of our tool. We do not collect or transmit [any information related to your codebase](https://github.com/search?q=repo:TaqlaAI/sourcebot++captureEvent&type=code). All events are [sanitized](https://github.com/TaqlaAI/sourcebot/blob/main/src/app/posthogProvider.tsx) to ensure that no sensitive or identifying details leave your machine. The data we collect includes general usage statistics and metadata such as query performance (e.g., search duration, error rates) to monitor the application's health and functionality. This information helps us better understand how Sourcebot is used and where improvements can be made :)
+By default, Sourcebot collects anonymized usage data through [PostHog](https://posthog.com/) to help us improve the performance and reliability of our tool. We do not collect or transmit [any information related to your codebase](https://github.com/search?q=repo:TaqlaAI/sourcebot++captureEvent&type=code). In addition, all events are [sanitized](https://github.com/TaqlaAI/sourcebot/blob/main/src/app/posthogProvider.tsx) to ensure that no sensitive or identifying details leave your machine. The data we collect includes general usage statistics and metadata such as query performance (e.g., search duration, error rates) to monitor the application's health and functionality. This information helps us better understand how Sourcebot is used and where improvements can be made :)
If you'd like to disable all telemetry, you can do so by setting the environment variable `SOURCEBOT_TELEMETRY_DISABLED` to `1` in the docker run command:
-```sh
-docker run -e SOURCEBOT_TELEMETRY_DISABLED=1 /* additional args */ ghcr.io/taqlaai/sourcebot:main
-```
-Or if you are building locally, add the following to your [.env](./.env) file:
+
+docker run -e SOURCEBOT_TELEMETRY_DISABLED=1 /* additional args */ ghcr.io/taqlaai/sourcebot:main
+
+
+Or if you are [building locally](#building-sourcebot), add the following to your [.env](./.env) file:
```sh
SOURCEBOT_TELEMETRY_DISABLED=1
NEXT_PUBLIC_SOURCEBOT_TELEMETRY_DISABLED=1
-