|
| 1 | +--- |
| 2 | +name: engraph |
| 3 | +description: Index and search document collections using hybrid semantic + graph + full-text search. Use when users need to search knowledge bases, find connections between documents, discover related content via link graphs, or query indexed markdown collections. |
| 4 | +license: MIT |
| 5 | +compatibility: Requires engraph CLI. Install via `brew install devwhodevs/tap/engraph` or from GitHub releases. |
| 6 | +metadata: |
| 7 | + author: jsynowiec |
| 8 | + version: "1.0.0" |
| 9 | +allowed-tools: Bash(engraph:*), mcp__engraph__* |
| 10 | +--- |
| 11 | + |
| 12 | +# Engraph — Hybrid Semantic & Graph Search for Document Collections |
| 13 | + |
| 14 | +Local knowledge engine for markdown document collections. Combines semantic embeddings, full-text search (BM25), wikilink graph traversal, temporal scoring, and cross-encoder reranking. |
| 15 | + |
| 16 | +## Status |
| 17 | + |
| 18 | +!`engraph status 2>/dev/null || echo "Not installed: brew install devwhodevs/tap/engraph"` |
| 19 | + |
| 20 | +## Indexing |
| 21 | + |
| 22 | +```bash |
| 23 | +engraph index /path/to/documents # Incremental; only changed files re-embedded |
| 24 | +engraph index /path/to/documents --rebuild |
| 25 | +engraph status # File count, health, stats |
| 26 | +engraph clear # Drop cached data and models |
| 27 | +``` |
| 28 | + |
| 29 | +## Search |
| 30 | + |
| 31 | +```bash |
| 32 | +engraph search "how does the auth flow work" |
| 33 | +engraph search "performance regressions last month" --explain |
| 34 | +engraph search "architecture decisions" -n 5 --json |
| 35 | +``` |
| 36 | + |
| 37 | +| Flag | Description | |
| 38 | +| ----------------- | ---------------------------------------------- | |
| 39 | +| `-n, --top-n <N>` | Number of results (default: from config or 10) | |
| 40 | +| `--explain` | Show per-lane RRF score breakdown | |
| 41 | +| `--json` | Machine-readable JSON output | |
| 42 | + |
| 43 | +### Query Tips |
| 44 | + |
| 45 | +- **Conceptual / vague**: Use natural language. The orchestrator classifies intent and boosts semantic weight automatically. |
| 46 | +- **Keyword-heavy**: Exact terms, identifiers, and names work well via the BM25 lane. |
| 47 | +- **Temporal**: "last week", "yesterday", "March 2026" — the temporal lane activates automatically. |
| 48 | + |
| 49 | +## Graph Inspection |
| 50 | + |
| 51 | +```bash |
| 52 | +engraph graph show "path/to/note.md" # Connections for a document |
| 53 | +engraph graph show "#docid" # By document ID |
| 54 | +engraph graph stats # Nodes, edges, density |
| 55 | +``` |
| 56 | + |
| 57 | +## Context Queries |
| 58 | + |
| 59 | +```bash |
| 60 | +engraph context topic "authentication" --budget 8000 |
| 61 | +engraph context who "Person Name" |
| 62 | +engraph context project "Project Name" |
| 63 | +engraph context vault-map # Collection structure overview |
| 64 | +engraph context health # Orphans, broken links, stale content, tag hygiene |
| 65 | +engraph context read "path/to/note.md" # Full content + metadata |
| 66 | +engraph context list --tag architecture # Filter by tag, folder, created_by, etc. |
| 67 | +``` |
| 68 | + |
| 69 | +## Setup |
| 70 | + |
| 71 | +```bash |
| 72 | +engraph index /path/to/documents |
| 73 | +engraph search "your query" |
| 74 | +``` |
0 commit comments