documentation for clearing the index (BloopAI#320)

playboy8 · Mar 23, 2023 · 55c22aa · 55c22aa
1 parent e0da0fd
commit 55c22aa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ For instructions on how to build from source or run bloop from the command line,
 
 Note that it is currently _not_ possible to run conversational GPT-4 search where bloop has been built from source (we're working on this). You can run regex searches and use code-navigation.
 
+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](./apps/desktop/README.md).
+
 ## Contributing
 
 We welcome contributions big and small! Before jumping in please read [our contributors guide](./CONTRIBUTING.md) and [our code of conduct](./CODE_OF_CONDUCT.md).

diff --git a/apps/desktop/README.md b/apps/desktop/README.md
@@ -39,3 +39,13 @@ Alternatively, to run the app in dev mode:
 ```
 npm run start-app
 ```
+
+## Wiping an index
+
+Deleting the bloop cache directory and re-indexing can fix a corrupted index. You can find the bloop cache here:
+
+| OS      | Cache Path |
+| ----------- | ----------- |
+| MacOS      | `~/Library/Caches/ai.bloop.bloop`       |
+| Windows   | `%LOCALAPPDATA%\ai.bloop.bloop`        |
+| Linux   | `~/.cache/ai.bloop.bloop`        |