bloop

bloop stands on the shoulders of the Rust ecosystem. Our search indexes are powered by Tantivy and Qdrant, and our multi-platform app is built with Tauri.

https://github.com/BloopAI/bloop/assets/7957964/93715188-d8d5-477b-8cd1-95d9cbd368cb

Get Started

The simplest way to get started with bloop is to download the app and follow the onboarding steps. Checkout our getting started guide and our references for conversational and regex search and Code Studio.

For instructions on how to build from source or run bloop from the command line, check out these pages:

• Build bloop app from source
• Run bloop from the command line

If you encounter any index issues you can wipe the bloop cache and reindex. Instructions on how to do this on different platforms are here.

Building From Source

You can build bloop from source and run it with your own OpenAI API key. Clone the repo, make sure the oss branch is checked out, and create a file called local_config.json at the top-level of the repo. local_config.json should contain the following fields:

{
    "github_access_token": "<YOUR_GITHUB_ACCESS_TOKEN>",
    "openai_api_key": "<YOUR_OPENAI_API_KEY>"
}

Then follow these installation instructions. If built from source, bloop will not collect any telemetry.

Contributing

We welcome contributions big and small! Before jumping in please read our contributors guide and our code of conduct.

Here's how to find your way around the repo:

• apps/desktop: The Tauri app
• server/bleep: The Rust backend which contains the core search and navigation logic
• client: The React frontend

We use Git LFS for dependencies that are expensive to build.

To make sure you have everything you need to start building, you'll need to install the git-lfs package for your favourite operating system, then run the following commands in this repo:

git lfs install
git lfs pull

If you find a bug or have a feature request, open an issue! You can find the application logs here:

Privacy

We store as little data as possible. We use telemetry to helps us identify bugs and make data-driven product decisions. You can read our full privacy policy here.

License

bloop is licensed under the Apache 2.0 license as defined in LICENSE.