mirror of
https://github.com/sourcebot-dev/sourcebot.git
synced 2025-12-11 20:05:25 +00:00
chore(readme): Update README with new videos (#410)
* demo thumbnail * features image * features * fix videos * fix videos * fix video references * readme * add videos for code nav and file explorer * video tag test * video embed test * autoplay test
This commit is contained in:
parent
f888085952
commit
5faf29ab6a
4 changed files with 32 additions and 19 deletions
|
|
@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Bumped next version. [#406](https://github.com/sourcebot-dev/sourcebot/pull/406)
|
||||
- [ask sb] Improved search code tool with filter options. [#400](https://github.com/sourcebot-dev/sourcebot/pull/400)
|
||||
- [ask sb] Removed search scope constraint. [#400](https://github.com/sourcebot-dev/sourcebot/pull/400)
|
||||
- Update README with new features and videos. [#410](https://github.com/sourcebot-dev/sourcebot/pull/410)
|
||||
- [ask sb] Add back search scope requirement and other UI changes. [#411](https://github.com/sourcebot-dev/sourcebot/pull/411)
|
||||
|
||||
## [4.6.0] - 2025-07-25
|
||||
|
|
|
|||
48
README.md
48
README.md
|
|
@ -12,7 +12,7 @@
|
|||
<strong>Self Host</strong>
|
||||
</a> ·
|
||||
<a href="https://demo.sourcebot.dev">
|
||||
<strong>Demo</strong>
|
||||
<strong>Public Demo</strong>
|
||||
</a>
|
||||
</h3>
|
||||
</div>
|
||||
|
|
@ -37,34 +37,46 @@
|
|||
<a href="https://github.com/sourcebot-dev/sourcebot/stargazers"><img src="https://img.shields.io/github/stars/sourcebot-dev/sourcebot" /></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/6Fhp27x7Pb"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/6Fhp27x7Pb?style=flat"/></a>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
# About
|
||||
|
||||
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.
|
||||
|
||||
https://github.com/user-attachments/assets/286ad97a-a543-4eef-a2f1-4fa31bea1b32
|
||||
Try it out in our [public demo](https://demo.sourcebot.dev)!
|
||||
|
||||
[](https://github.com/user-attachments/assets/286ad97a-a543-4eef-a2f1-4fa31bea1b32)
|
||||
|
||||
|
||||
## Features
|
||||
- 💻 **One-command deployment**: Get started instantly using Docker on your own machine.
|
||||
- 🤖 **Bring your own model**: Connect Sourcebot to any of the reasoning models you're already using.
|
||||
- 🔍 **Multi-repo support**: Index and search through multiple public and private repositories and branches on GitHub, GitLab, Bitbucket, Gitea, or Gerrit.
|
||||
- ⚡ **Lightning fast performance**: Built on top of the powerful [Zoekt](https://github.com/sourcegraph/zoekt) search engine.
|
||||
- 🎨 **Modern web app**: Enjoy a sleek interface with features like syntax highlighting, light/dark mode, and vim-style navigation.
|
||||
- 📂 **Full file visualization**: Instantly view the entire file when selecting any search result.
|
||||
# Features
|
||||

|
||||
|
||||
You can try out our public hosted demo [here](https://demo.sourcebot.dev)!
|
||||
## 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.
|
||||
|
||||
<video src="https://github.com/user-attachments/assets/feb82cde-51fc-42f9-830d-8f149d328a0b" width="100%" controls autoplay loop muted></video>
|
||||
|
||||
## 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.
|
||||
|
||||
<video src="https://github.com/user-attachments/assets/022f0bd0-db45-45ba-a31f-7bd43b6e2e25" width="100%" controls autoplay loop muted></video>
|
||||
|
||||
## Code Navigation
|
||||
IDE-level code navigation (goto definition and find references) across all your repos.
|
||||
|
||||
<video src="https://github.com/user-attachments/assets/86c1cd58-c4d1-4481-a2d3-fcbb79d98203" width="100%" controls autoplay loop muted></video>
|
||||
|
||||
## Built-in File Explorer
|
||||
Explore every file across all of your repos. Modern UI with syntax highlighting, file tree, code navigation, etc.
|
||||
|
||||
<video src="https://github.com/user-attachments/assets/42d5782b-9e8d-4de2-a3b9-6db972901638" width="100%" controls autoplay loop muted></video>
|
||||
|
||||
# Deploy Sourcebot
|
||||
|
||||
Sourcebot can be deployed in seconds using our official docker image. Visit our [docs](https://docs.sourcebot.dev/self-hosting/overview) for more information.
|
||||
Sourcebot can be deployed in seconds using our official docker image. Visit our [docs](https://docs.sourcebot.dev/docs/deployment-guide) for more information.
|
||||
|
||||
1. Create a config
|
||||
```sh
|
||||
|
|
@ -106,10 +118,10 @@ docker run \
|
|||
</details>
|
||||
</br>
|
||||
|
||||
3. Start searching at `http://localhost:3000`
|
||||
3. Visit `http://localhost:3000` to start using Sourcebot
|
||||
</br>
|
||||
|
||||
To learn how to configure Sourcebot to index your own repos, please refer to our [docs](https://docs.sourcebot.dev/self-hosting/overview).
|
||||
To configure Sourcebot (index your own repos, connect your LLMs, etc), check out our [docs](https://docs.sourcebot.dev/docs/configuration/config-file).
|
||||
|
||||
> [!NOTE]
|
||||
> Sourcebot collects <a href="https://demo.sourcebot.dev/~/search?query=captureEvent%5C(%20repo%3Asourcebot">anonymous usage data</a> 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
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ Search across all your repos/branches across any code host platform. Blazingly f
|
|||
loop
|
||||
playsInline
|
||||
className="w-full aspect-video"
|
||||
src="https://framerusercontent.com/assets/B9ZxrlsUeO9NJyzkKyvVV2KSU4.mp4"
|
||||
src="/images/code_nav.mp4"
|
||||
></video>
|
||||
|
||||
|
||||
|
|
|
|||
BIN
docs/images/code_nav.mp4
Normal file
BIN
docs/images/code_nav.mp4
Normal file
Binary file not shown.
Loading…
Reference in a new issue