Skip to content

chore: document project scope in README and Overview #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lbruton merged 1 commit into from
Oct 29, 2026
Merged

chore: document project scope in README and Overview #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion DocVault/Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@
## Operational Notes

- Embedding model is downloaded via `download-model.sh` — EmbeddingGemma local on Apple Silicon (MLX Metal).
- **Gotcha:** `search_all_sessions` silently returns empty when a `project_root` filesystem path is passed. Omit the filter or pass `"*"`.
- **Project scope:** `project_root` takes a path (its indexed subfolders and worktrees are included), a folder name such as `CoWork`, or `"*"`. A name or path with no indexed turns searches every project. Search and stats output opens with a `Scope:` line that names the roots and the reason.
- **Gotcha:** Claude desktop Code-tab sessions, Desktop chat and Codex send no `X-Project-Root` header, so their searches default to every project. Pass `project_root` explicitly from those clients.

Check notice on line 59 in DocVault/Overview.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

DocVault/Overview.md#L59 

Expected: 80; Actual: 198
- **MLX Metal SIGSEGV under sustained load** — EmbeddingGemma crashes the GPU driver after ~50min continuous compute. Backfill throttle is 200ms between inserts; do not drop below 100ms.
- **FTS schema migration** writes a sentinel and emits a `WARNING` log line while the keyword index rebuilds — expected, not an error.
- **LaunchAgent (optional):** `cc.lbruton.sessionflow` user agent autostarts the server at login. Disable via `launchctl unload` if running ad-hoc.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ SessionFlow HTTP server (SESSIONFLOW_PORT, default 7102)
| Tool | Returns |
|------|---------|
| `search_session` | Turns that match a query, scoped to the current project. Omit `query` to list recent turns. |
| `search_all_sessions` | Turns that match a query, with `project_root`, `git_branch`, `provider`, `date_from`, `date_to` and `issue_id` filters. |
| `search_all_sessions` | Turns that match a query, with `project_root`, `git_branch`, `provider`, `date_from`, `date_to` and `issue_id` filters. `project_root` takes a path, a folder name such as `CoWork`, or `"*"`. |
| `get_turns` | The turns around one turn of a session. Requires `session_id` and `turn_index` from a search result. |
| `get_session_stats` | Turn, session, branch and provider counts for the index. |
| `get_issue_timeline` | Every turn that mentions an issue ID, oldest first. Requires `issue_id`. |
Expand Down
Loading