From 5faf29ab6a27dd5e11a4645ce2ea0fc516de6dfa Mon Sep 17 00:00:00 2001
From: Michael Sukkarieh
-
- - -# 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. + + + +## 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 0000000000000000000000000000000000000000..754b79ff6eb2ab67af14b45a2e6d26fd739ca86a GIT binary patch literal 4029785 zcmV)OK(@aC001Cnba`-Tb8l?`00IDMb8l^Fb8j+Xc4IMZa5OOh000PPa%E)zJ#7PR zWMOmw0015a1sX?IO59vbLqC-7#SuKwL#P4&%*_7+03aQJfB*n`R3*3|0WZlG;7|X` z;nhv|W0|?SC@WrI0009300RI30{{SixU+1QQxcpx1TSgBHBihf6I&LtMog6(B$Wzsyhb=te?Fc!i-vrZQ
zqZ(a0M%4
zB|MaO>F*)Q2ebd-HhOk5W8b7K^`v|&hgw1Z+PM!^=fQ&sE-nZX ;KzHwN%+JtqV)
z|JKUJzK1L)xWZ=fjr+u3lxm1a%@{XQl;t=fcwY(S0SR>4uH*Hji5oqdo=5#cq6=s(
zGO*Al;Vw?A@soVMTLG4;&X4+ES6IX=O%kiN9=`5{xy(2K7
wZdoUHdSt)ARLR~W)LaMO
z?**0;Az<+H{H6wdRUt>?QZKtBLsAUsvQOvdP9c}RXIH*d@9`u6%DPOvO>B)ZIZgm4
z@(k=;t~B(2X)zjSTEApN8-^DJPXNZgraQOck9msGEl$W)GAn|N_9#CEHd>uRGsvwP
zJVOo?68OIu?K2i}`6KxjQJ(Z{-R6Yf1OXG;A4aW0QtQ9~00RKU9{we2+V*0(p9|YR
z?dTKnUz7Mnwdh`*2#O~@^z>zfR7Vr*f$cSOVh>p4VK}vmv-%(#cmB@iT(`>tbtxnQ
z0L-GBVCnB}ER{fLeP^cT=H$8Ahc=N)z&g^0&+n`f>Q}{-4qR(Wx)1UgFO#KRLSVi%e%BN*P)7FkgD;47lWN3xQ3(Hsaun
z6QR;&eik$;uzKcJzwBJ<05#p}`^qz>z|o?{up3BkbM##l&TJwYf_A=KK{Urw4f9T+
zkj8DefB4fjS;`_v+5T1B<_RbNxYOVnkGRxtc;?i8xuKLzVN^9u><)}$T4qirE^iW$
zWH*o@$G^?8N~!`vu@o>KDI!51Wbt%Ob<;}zxWqR5w>r;=6AimZ_wX)Sm8USSUJVAD
zE1`vjg&hd29YcVcfUuk+ZVh)b3u;ctyjGtOhS2`A8hx|v8-_}Yw+{*^${967xow{B
zP+J6Kmim4?q-Ue+eiA;Q0uZ6<0IE-WS%waN?J_Ljf^y6I${pGP|%_&E_`-6Zj
zgR-$q&s1@XcjWMG@dm&1CT~Wl4A>pU^pKBk<`n+xJOBU#004cEp}>2uasq0T4H+Um
zd=>Zd9Ex+zoD>s*958BYOCFo@p-ovS0gQjo|CxXNQSNvhUA8afvnzJ6QhYOEvy2HF
zHyNN!j8%qjCctamU#b8KBW?qIl}cw&44u$c=cB(F_#(12W&3EohX{;rSn!Hj>pb_q
zo_R?V)q23MkpM8AR>Uy+%i(}jl7P=7vZCSEyOq;0;G)+KmHq}5-nwK-4?&_j
JOLG!UJD*Qgy@!f*9tDFQ
z?-K-n$1+-TN~6*
zfS(NPD87ZCS#8nV0(uQGj`W;A70mMHzdkz6Ewv)oUc5gpHoCYL+j%x
s$0Bosfu
zQq};zH@B^RbglMb;E1>q;!FiJ0