Getting Started

This guide takes you through setting up bloop and making your first search in under 5 minutes. bloop is a desktop app for fast private code search. bloop works on Mac, Windows and Linux and can be easily built from source.

Download

Download bloop from the releases section on our GitHub page. We currently support the following architectures:

  • Mac (Apple Silicon)
  • Mac (Intel)
  • Windows (x86)
  • Linux

First steps

bloop's onboarding pages will be shown on first launch. It takes 5 easy steps to get started:

1. Telemetry

Telemetry

We store as little data as possible. Opting in now to send telemetry to bloop helps us identify bugs and make data-driven product decisions. This option sends us crash reports, logs and high level information about feature usage (so we can tell that a search was made, but we wouldn't be able to see the query or results). If you change your mind, you can always disable this later in Settings!

2. Subscribe to our updates

Share details

Share your name and email so we can keep you in the loop about the latest bloop developments. We also hate spam, and you have our pinky promise that we'll keep all emails interesting 🤙

3. Sync local repos

Choose local folder

To sync your local repos, you must first choose a folder to scan.

Choose local repos

After the scan is complete, you can choose which repos to sync.

Choose all local repos

You can also just index everything, bloop will keep your results relevant.

4. Sync GitHub repos

Sign in with GitHub

You can also sync repos from your GitHub account. To sign in with OAuth, first copy the device code. Clicking "Connect GitHub" will send you to a GitHub login page where you need to paste it. Choose the organisations and repositories you'd like to download and search, then click "Authorise".

Remember how you chose your local repos? Select your GitHub repos the same way, and you're all set!

5. Wait for your repos to sync

Main screen

On the main screen you can see all your repos and their sync status. Syncing can take anywhere from seconds to a few minutes depending on the size and number of repos being synced.

Once the status indicator changes to green 🟢 you'll be able to make a query for code in that repo.


Next: Writing queries