mirror of
https://github.com/sourcebot-dev/sourcebot.git
synced 2025-12-12 04:15:30 +00:00
indent README
This commit is contained in:
bkellam
parent
b9694c9c76
commit
4355567351
1 changed files with 66 additions and 66 deletions
132
README.md
132
README.md
|
|
@ -27,18 +27,18 @@ Sourcebot is a fast code indexing and search tool for your codebases. It is buil
|
|||
|
||||
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`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
|
||||
"Configs": [
|
||||
{
|
||||
"Type": "github",
|
||||
"GitHubOrg": "TaqlaAI",
|
||||
"Name": "^sourcebot$"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
```json
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
|
||||
"Configs": [
|
||||
{
|
||||
"Type": "github",
|
||||
"GitHubOrg": "TaqlaAI",
|
||||
"Name": "^sourcebot$"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](./schemas/index.json) for a full list of available options.
|
||||
|
||||
|
|
@ -69,47 +69,47 @@ Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](.
|
|||
|
||||
3. Launch the latest image from the [ghcr registry](https://github.com/TaqlaAI/sourcebot/pkgs/container/sourcebot):
|
||||
|
||||
<div>
|
||||
<details open>
|
||||
<summary><img src="https://github.com/favicon.ico" width="16" height="16" /> GitHub</summary>
|
||||
<div>
|
||||
<details open>
|
||||
<summary><img src="https://github.com/favicon.ico" width="16" height="16" /> GitHub</summary>
|
||||
|
||||
```sh
|
||||
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITHUB_TOKEN=<token> ghcr.io/taqlaai/sourcebot:main
|
||||
```
|
||||
</details>
|
||||
```sh
|
||||
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITHUB_TOKEN=<token> ghcr.io/taqlaai/sourcebot:main
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><img src="https://gitlab.com/favicon.ico" width="16" height="16" /> GitLab</summary>
|
||||
<details>
|
||||
<summary><img src="https://gitlab.com/favicon.ico" width="16" height="16" /> GitLab</summary>
|
||||
|
||||
```sh
|
||||
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITLAB_TOKEN=<token> ghcr.io/taqlaai/sourcebot:main
|
||||
```
|
||||
```sh
|
||||
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITLAB_TOKEN=<token> ghcr.io/taqlaai/sourcebot:main
|
||||
```
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><img src="https://bitbucket.org/favicon.ico" width="16" height="16" /> BitBucket</summary>
|
||||
<details>
|
||||
<summary><img src="https://bitbucket.org/favicon.ico" width="16" height="16" /> BitBucket</summary>
|
||||
|
||||
TODO
|
||||
TODO
|
||||
|
||||
</details>
|
||||
<br/>
|
||||
</div>
|
||||
</details>
|
||||
<br/>
|
||||
</div>
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
```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 <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)
|
||||
```
|
||||
```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 <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.
|
||||
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 a index has been created, you can start searching.
|
||||
|
||||
|
|
@ -118,32 +118,32 @@ zoekt will now index your repositories (at `HEAD`). By default, it will re-index
|
|||
0. Install <a href="https://go.dev/"><img src="https://go.dev/favicon.ico" width="16" height="16"> go</a> and <a href="https://nodejs.org/"><img src="https://nodejs.org/favicon.ico" width="16" height="16"> NodeJS</a>
|
||||
|
||||
1. Clone the repository with submodules:
|
||||
```sh
|
||||
git clone --recurse-submodules https://github.com/TaqlaAI/sourcebot.git
|
||||
```
|
||||
```sh
|
||||
git clone --recurse-submodules https://github.com/TaqlaAI/sourcebot.git
|
||||
```
|
||||
|
||||
2. Run make to build zoekt and install dependencies:
|
||||
```sh
|
||||
cd sourcebot
|
||||
make
|
||||
```
|
||||
```sh
|
||||
cd sourcebot
|
||||
make
|
||||
```
|
||||
|
||||
The zoekt binaries and web dependencies are placed into `bin` and `node_modules` respectively.
|
||||
|
||||
3. Create a `config.json` file and list the repositories you want to index. The JSON schema defined in [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`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
|
||||
"Configs": [
|
||||
{
|
||||
"Type": "github",
|
||||
"GitHubOrg": "TaqlaAI",
|
||||
"Name": "^sourcebot$"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
```json
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/TaqlaAI/sourcebot/main/schemas/index.json",
|
||||
"Configs": [
|
||||
{
|
||||
"Type": "github",
|
||||
"GitHubOrg": "TaqlaAI",
|
||||
"Name": "^sourcebot$"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
4. Create a Personal Access Token (PAT) to authenticate with a code host:
|
||||
|
||||
|
|
@ -173,11 +173,11 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules`
|
|||
</div>
|
||||
|
||||
5. Start Sourcebot with the command:
|
||||
```sh
|
||||
yarn dev
|
||||
```
|
||||
```sh
|
||||
yarn dev
|
||||
```
|
||||
|
||||
A `.sourcebot` directory will be created and zoekt will begin to index the repositories found given `config.json`.
|
||||
A `.sourcebot` directory will be created and zoekt will begin to index the repositories found given `config.json`.
|
||||
|
||||
6. Go to `http://localhost:3000` - once a index has been created, you can start searching.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue