diff --git a/CHANGELOG.md b/CHANGELOG.md index f80f4a22..ac8410f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index e5940334..5ade197b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Self Host Β· - Demo + Public Demo @@ -37,34 +37,46 @@

-

-

-

- -# 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)! + +[![Sourcebot Demo](https://github.com/user-attachments/assets/147f53ad-5912-4c76-a5d8-371d480fff24)](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 +![Sourcebot Features](https://github.com/user-attachments/assets/3aed7348-7aeb-4af3-89da-b617c3db2e02) -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. + + + +## 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. + + + +## Code Navigation +IDE-level code navigation (goto definition and find references) across all your repos. + + + +## Built-in File Explorer +Explore every file across all of your repos. Modern UI with syntax highlighting, file tree, code navigation, etc. + + # 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 \
-3. Start searching at `http://localhost:3000` +3. Visit `http://localhost:3000` to start using Sourcebot
-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 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_DISABLED` environment diff --git a/docs/docs/overview.mdx b/docs/docs/overview.mdx index 2363323b..3139e34f 100644 --- a/docs/docs/overview.mdx +++ b/docs/docs/overview.mdx @@ -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" > diff --git a/docs/images/code_nav.mp4 b/docs/images/code_nav.mp4 new file mode 100644 index 00000000..754b79ff Binary files /dev/null and b/docs/images/code_nav.mp4 differ