Skip to content

Commit 83c153f

Browse files
committed
docs: add performance notes to README regarding initial indexing, caching, and future updates.
1 parent d86c350 commit 83c153f

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,13 @@ Now the agent checks patterns automatically instead of waiting for you to ask.
6363
| `EMBEDDING_PROVIDER` | `transformers` | `openai` (fast, cloud) or `transformers` (local, private) |
6464
| `OPENAI_API_KEY` | - | Required if provider is `openai` |
6565

66+
## Performance Note
67+
68+
This tool runs **locally** on your machine using your hardware.
69+
- **Initial Indexing**: The first run works hard. It may take several minutes (e.g., ~2-5 mins for 30k files) to compute embeddings for your entire codebase.
70+
- **Caching**: Subsequent queries are instant (milliseconds).
71+
- **Updates**: Currently, `refresh_index` re-scans the codebase. True incremental indexing (processing only changed files) is on the roadmap.
72+
6673
## Links
6774

6875
- 📄 [Motivation](./MOTIVATION.md) — Why this exists, research, learnings

0 commit comments

Comments
 (0)