Skip to content

Commit 4ec5abf

Browse files
docs: document commitmux as optional dependency for context search
Add Dependencies section explaining graceful degradation: - With commitmux: 4/4 sources (memory + commits + tasks + transcripts) - Without commitmux: 2/4 sources (tasks + transcripts) + upgrade message Mark memory and commit sources as 'Requires commitmux' in headers
1 parent 1a357e3 commit 4ec5abf

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

docs/features/CONTEXT_SEARCH.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,20 @@ Traditional search requires you to know where to look:
1212

1313
Context search eliminates this decision. You query once, search in parallel across all four sources, and get unified results ranked by relevance.
1414

15+
## Dependencies
16+
17+
**Optional:** commitmux binary for full functionality (4/4 sources)
18+
19+
- **With commitmux:** All 4 sources available (memory, commit, task history, transcript)
20+
- **Without commitmux:** 2 sources available (task history, transcript) with upgrade message
21+
22+
Install commitmux: `brew install blackwell-systems/tap/commitmux`
23+
24+
Context search degrades gracefully when commitmux is unavailable - you get partial results with clear instructions for upgrading.
25+
1526
## The Four Sources
1627

17-
### 1. Memory (Semantic)
28+
### 1. Memory (Semantic)**Requires commitmux**
1829

1930
Searches `commitmux` memory files using semantic embeddings. Finds conceptually related content even when exact keywords don't match.
2031

@@ -31,7 +42,7 @@ Searches `commitmux` memory files using semantic embeddings. Finds conceptually
3142

3243
**Use case:** "What did we decide about authentication architecture?"
3344

34-
### 2. Commits (Semantic)
45+
### 2. Commits (Semantic)**Requires commitmux**
3546

3647
Searches commit messages using semantic embeddings. Finds commits by intent or topic, not just keyword matching.
3748

0 commit comments

Comments
 (0)