feed-the-machine 1.6.1 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +170 -170
- package/bin/brain.py +1340 -0
- package/bin/convert_claude_skills_to_codex.py +490 -0
- package/bin/generate-manifest.mjs +463 -463
- package/bin/harden_codex_skills.py +141 -0
- package/bin/install.mjs +491 -491
- package/bin/migrate-eng-buddy-data.py +875 -0
- package/bin/playbook_engine/__init__.py +1 -0
- package/bin/playbook_engine/conftest.py +8 -0
- package/bin/playbook_engine/extractor.py +33 -0
- package/bin/playbook_engine/manager.py +102 -0
- package/bin/playbook_engine/models.py +84 -0
- package/bin/playbook_engine/registry.py +35 -0
- package/bin/playbook_engine/test_extractor.py +72 -0
- package/bin/playbook_engine/test_integration.py +129 -0
- package/bin/playbook_engine/test_manager.py +85 -0
- package/bin/playbook_engine/test_models.py +166 -0
- package/bin/playbook_engine/test_registry.py +67 -0
- package/bin/playbook_engine/test_tracer.py +86 -0
- package/bin/playbook_engine/tracer.py +93 -0
- package/bin/tasks_db.py +456 -0
- package/docs/HOOKS.md +243 -243
- package/docs/INBOX.md +233 -233
- package/ftm/SKILL.md +125 -122
- package/ftm-audit/SKILL.md +623 -623
- package/ftm-audit/references/protocols/PROJECT-PATTERNS.md +91 -91
- package/ftm-audit/references/protocols/RUNTIME-WIRING.md +66 -66
- package/ftm-audit/references/protocols/WIRING-CONTRACTS.md +135 -135
- package/ftm-audit/references/strategies/AUTO-FIX-STRATEGIES.md +69 -69
- package/ftm-audit/references/templates/REPORT-FORMAT.md +96 -96
- package/ftm-audit/scripts/run-knip.sh +23 -23
- package/ftm-audit.yml +2 -2
- package/ftm-brainstorm/SKILL.md +1003 -498
- package/ftm-brainstorm/evals/evals.json +180 -100
- package/ftm-brainstorm/evals/promptfoo.yaml +109 -109
- package/ftm-brainstorm/references/agent-prompts.md +552 -224
- package/ftm-brainstorm/references/plan-template.md +209 -121
- package/ftm-brainstorm.yml +2 -2
- package/ftm-browse/SKILL.md +454 -454
- package/ftm-browse/daemon/browser-manager.ts +206 -206
- package/ftm-browse/daemon/bun.lock +30 -30
- package/ftm-browse/daemon/cli.ts +347 -347
- package/ftm-browse/daemon/commands.ts +410 -410
- package/ftm-browse/daemon/main.ts +357 -357
- package/ftm-browse/daemon/package.json +17 -17
- package/ftm-browse/daemon/server.ts +189 -189
- package/ftm-browse/daemon/snapshot.ts +519 -519
- package/ftm-browse/daemon/tsconfig.json +22 -22
- package/ftm-browse.yml +4 -4
- package/ftm-capture/SKILL.md +370 -370
- package/ftm-capture.yml +4 -4
- package/ftm-codex-gate/SKILL.md +361 -361
- package/ftm-codex-gate.yml +2 -2
- package/ftm-config/SKILL.md +422 -345
- package/ftm-config.default.yml +125 -82
- package/ftm-config.yml +44 -2
- package/ftm-council/SKILL.md +416 -416
- package/ftm-council/references/prompts/CLAUDE-INVESTIGATION.md +60 -60
- package/ftm-council/references/prompts/CODEX-INVESTIGATION.md +58 -58
- package/ftm-council/references/prompts/GEMINI-INVESTIGATION.md +58 -58
- package/ftm-council/references/prompts/REBUTTAL-TEMPLATE.md +57 -57
- package/ftm-council/references/protocols/PREREQUISITES.md +47 -47
- package/ftm-council/references/protocols/STEP-0-FRAMING.md +46 -46
- package/ftm-council.yml +2 -2
- package/ftm-dashboard/SKILL.md +163 -163
- package/ftm-dashboard.yml +4 -4
- package/ftm-debug/SKILL.md +1037 -1037
- package/ftm-debug/references/phases/PHASE-0-INTAKE.md +58 -58
- package/ftm-debug/references/phases/PHASE-1-TRIAGE.md +46 -46
- package/ftm-debug/references/phases/PHASE-2-WAR-ROOM-AGENTS.md +279 -279
- package/ftm-debug/references/phases/PHASE-3-TO-6-EXECUTION.md +436 -436
- package/ftm-debug/references/protocols/BLACKBOARD.md +86 -86
- package/ftm-debug/references/protocols/EDGE-CASES.md +103 -103
- package/ftm-debug.yml +2 -2
- package/ftm-diagram/SKILL.md +277 -277
- package/ftm-diagram.yml +2 -2
- package/ftm-executor/SKILL.md +777 -777
- package/ftm-executor/references/STYLE-TEMPLATE.md +73 -73
- package/ftm-executor/references/phases/PHASE-0-VERIFICATION.md +62 -62
- package/ftm-executor/references/phases/PHASE-2-AGENT-ASSEMBLY.md +34 -34
- package/ftm-executor/references/phases/PHASE-3-WORKTREES.md +38 -38
- package/ftm-executor/references/phases/PHASE-4-5-AUDIT.md +72 -72
- package/ftm-executor/references/phases/PHASE-4-DISPATCH.md +66 -66
- package/ftm-executor/references/phases/PHASE-5-5-CODEX-GATE.md +73 -73
- package/ftm-executor/references/protocols/DOCUMENTATION-BOOTSTRAP.md +36 -36
- package/ftm-executor/references/protocols/MODEL-PROFILE.md +59 -59
- package/ftm-executor/references/protocols/PROGRESS-TRACKING.md +66 -66
- package/ftm-executor/runtime/ftm-runtime.mjs +252 -252
- package/ftm-executor/runtime/package.json +8 -8
- package/ftm-executor.yml +2 -2
- package/ftm-git/SKILL.md +441 -441
- package/ftm-git/evals/evals.json +26 -26
- package/ftm-git/evals/promptfoo.yaml +75 -75
- package/ftm-git/hooks/post-commit-experience.sh +92 -92
- package/ftm-git/references/patterns/SECRET-PATTERNS.md +104 -104
- package/ftm-git/references/protocols/REMEDIATION.md +139 -139
- package/ftm-git/scripts/pre-commit-secrets.sh +110 -110
- package/ftm-git.yml +2 -2
- package/ftm-inbox/backend/__pycache__/main.cpython-314.pyc +0 -0
- package/ftm-inbox/backend/adapters/_retry.py +64 -64
- package/ftm-inbox/backend/adapters/base.py +230 -230
- package/ftm-inbox/backend/adapters/freshservice.py +104 -104
- package/ftm-inbox/backend/adapters/gmail.py +125 -125
- package/ftm-inbox/backend/adapters/jira.py +136 -136
- package/ftm-inbox/backend/adapters/registry.py +192 -192
- package/ftm-inbox/backend/adapters/slack.py +110 -110
- package/ftm-inbox/backend/db/connection.py +54 -54
- package/ftm-inbox/backend/db/schema.py +78 -78
- package/ftm-inbox/backend/executor/__init__.py +7 -7
- package/ftm-inbox/backend/executor/engine.py +149 -149
- package/ftm-inbox/backend/executor/step_runner.py +98 -98
- package/ftm-inbox/backend/main.py +103 -103
- package/ftm-inbox/backend/models/__init__.py +1 -1
- package/ftm-inbox/backend/models/unified_task.py +36 -36
- package/ftm-inbox/backend/planner/__init__.py +6 -6
- package/ftm-inbox/backend/planner/__pycache__/__init__.cpython-314.pyc +0 -0
- package/ftm-inbox/backend/planner/__pycache__/generator.cpython-314.pyc +0 -0
- package/ftm-inbox/backend/planner/__pycache__/schema.cpython-314.pyc +0 -0
- package/ftm-inbox/backend/planner/generator.py +127 -127
- package/ftm-inbox/backend/planner/schema.py +34 -34
- package/ftm-inbox/backend/requirements.txt +5 -5
- package/ftm-inbox/backend/routes/__pycache__/plan.cpython-314.pyc +0 -0
- package/ftm-inbox/backend/routes/execute.py +186 -186
- package/ftm-inbox/backend/routes/health.py +52 -52
- package/ftm-inbox/backend/routes/inbox.py +68 -68
- package/ftm-inbox/backend/routes/plan.py +271 -271
- package/ftm-inbox/bin/launchagent.mjs +91 -91
- package/ftm-inbox/bin/setup.mjs +188 -188
- package/ftm-inbox/bin/start.sh +10 -10
- package/ftm-inbox/bin/status.sh +17 -17
- package/ftm-inbox/bin/stop.sh +8 -8
- package/ftm-inbox/config.example.yml +55 -55
- package/ftm-inbox/package-lock.json +2898 -2898
- package/ftm-inbox/package.json +26 -26
- package/ftm-inbox/postcss.config.js +6 -6
- package/ftm-inbox/src/app.css +199 -199
- package/ftm-inbox/src/app.html +18 -18
- package/ftm-inbox/src/lib/api.ts +166 -166
- package/ftm-inbox/src/lib/components/ExecutionLog.svelte +81 -81
- package/ftm-inbox/src/lib/components/InboxFeed.svelte +143 -143
- package/ftm-inbox/src/lib/components/PlanStep.svelte +271 -271
- package/ftm-inbox/src/lib/components/PlanView.svelte +206 -206
- package/ftm-inbox/src/lib/components/StreamPanel.svelte +99 -99
- package/ftm-inbox/src/lib/components/TaskCard.svelte +190 -190
- package/ftm-inbox/src/lib/components/ui/EmptyState.svelte +63 -63
- package/ftm-inbox/src/lib/components/ui/KawaiiCard.svelte +86 -86
- package/ftm-inbox/src/lib/components/ui/PillButton.svelte +106 -106
- package/ftm-inbox/src/lib/components/ui/StatusBadge.svelte +67 -67
- package/ftm-inbox/src/lib/components/ui/StreamDrawer.svelte +149 -149
- package/ftm-inbox/src/lib/components/ui/ThemeToggle.svelte +80 -80
- package/ftm-inbox/src/lib/theme.ts +47 -47
- package/ftm-inbox/src/routes/+layout.svelte +76 -76
- package/ftm-inbox/src/routes/+page.svelte +401 -401
- package/ftm-inbox/svelte.config.js +12 -12
- package/ftm-inbox/tailwind.config.ts +63 -63
- package/ftm-inbox/tsconfig.json +13 -13
- package/ftm-inbox/vite.config.ts +6 -6
- package/ftm-intent/SKILL.md +241 -241
- package/ftm-intent.yml +2 -2
- package/ftm-manifest.json +3794 -3794
- package/ftm-map/SKILL.md +291 -291
- package/ftm-map/scripts/db.py +712 -712
- package/ftm-map/scripts/index.py +415 -415
- package/ftm-map/scripts/parser.py +224 -224
- package/ftm-map/scripts/queries/go-tags.scm +20 -20
- package/ftm-map/scripts/queries/javascript-tags.scm +35 -35
- package/ftm-map/scripts/queries/python-tags.scm +31 -31
- package/ftm-map/scripts/queries/ruby-tags.scm +19 -19
- package/ftm-map/scripts/queries/rust-tags.scm +37 -37
- package/ftm-map/scripts/queries/typescript-tags.scm +41 -41
- package/ftm-map/scripts/query.py +301 -301
- package/ftm-map/scripts/ranker.py +377 -377
- package/ftm-map/scripts/requirements.txt +5 -5
- package/ftm-map/scripts/setup-hooks.sh +27 -27
- package/ftm-map/scripts/setup.sh +56 -56
- package/ftm-map/scripts/test_db.py +364 -364
- package/ftm-map/scripts/test_parser.py +174 -174
- package/ftm-map/scripts/test_query.py +183 -183
- package/ftm-map/scripts/test_ranker.py +199 -199
- package/ftm-map/scripts/views.py +591 -591
- package/ftm-map.yml +2 -2
- package/ftm-mind/SKILL.md +201 -1943
- package/ftm-mind/evals/promptfoo.yaml +142 -142
- package/ftm-mind/references/blackboard-protocol.md +110 -0
- package/ftm-mind/references/blackboard-schema.md +328 -328
- package/ftm-mind/references/complexity-guide.md +110 -110
- package/ftm-mind/references/complexity-sizing.md +138 -0
- package/ftm-mind/references/decide-act-protocol.md +172 -0
- package/ftm-mind/references/direct-execution.md +51 -0
- package/ftm-mind/references/environment-discovery.md +77 -0
- package/ftm-mind/references/event-registry.md +319 -319
- package/ftm-mind/references/mcp-inventory.md +300 -296
- package/ftm-mind/references/ops-routing.md +47 -0
- package/ftm-mind/references/orient-protocol.md +234 -0
- package/ftm-mind/references/personality.md +40 -0
- package/ftm-mind/references/protocols/COMPLEXITY-SIZING.md +72 -72
- package/ftm-mind/references/protocols/MCP-HEURISTICS.md +32 -32
- package/ftm-mind/references/protocols/PLAN-APPROVAL.md +80 -80
- package/ftm-mind/references/reflexion-protocol.md +249 -249
- package/ftm-mind/references/routing/SCENARIOS.md +22 -22
- package/ftm-mind/references/routing-scenarios.md +35 -35
- package/ftm-mind.yml +2 -2
- package/ftm-ops.yml +4 -0
- package/ftm-pause/SKILL.md +395 -395
- package/ftm-pause/references/protocols/SKILL-RESTORE-PROTOCOLS.md +186 -186
- package/ftm-pause/references/protocols/VALIDATION.md +80 -80
- package/ftm-pause.yml +2 -2
- package/ftm-researcher/SKILL.md +275 -275
- package/ftm-researcher/evals/agent-diversity.yaml +17 -17
- package/ftm-researcher/evals/synthesis-quality.yaml +12 -12
- package/ftm-researcher/evals/trigger-accuracy.yaml +39 -39
- package/ftm-researcher/references/adaptive-search.md +116 -116
- package/ftm-researcher/references/agent-prompts.md +193 -193
- package/ftm-researcher/references/council-integration.md +193 -193
- package/ftm-researcher/references/output-format.md +203 -203
- package/ftm-researcher/references/synthesis-pipeline.md +165 -165
- package/ftm-researcher/scripts/score_credibility.py +234 -234
- package/ftm-researcher/scripts/validate_research.py +92 -92
- package/ftm-researcher.yml +2 -2
- package/ftm-resume/SKILL.md +518 -518
- package/ftm-resume/references/protocols/VALIDATION.md +172 -172
- package/ftm-resume.yml +2 -2
- package/ftm-retro/SKILL.md +380 -380
- package/ftm-retro/references/protocols/SCORING-RUBRICS.md +89 -89
- package/ftm-retro/references/templates/REPORT-FORMAT.md +109 -109
- package/ftm-retro.yml +2 -2
- package/ftm-routine/SKILL.md +170 -170
- package/ftm-routine.yml +4 -4
- package/ftm-state/blackboard/capabilities.json +5 -5
- package/ftm-state/blackboard/capabilities.schema.json +27 -27
- package/ftm-state/blackboard/context.json +37 -23
- package/ftm-state/blackboard/experiences/doom-statusline-fix.json +26 -0
- package/ftm-state/blackboard/experiences/hackathon-pages-site.json +26 -0
- package/ftm-state/blackboard/experiences/hindsight-sso-kickoff.json +42 -0
- package/ftm-state/blackboard/experiences/index.json +58 -9
- package/ftm-state/blackboard/experiences/learning-ragnarok-api-access.json +23 -0
- package/ftm-state/blackboard/experiences/nordlayer-members-auto-assign.json +26 -0
- package/ftm-state/blackboard/experiences/saml2aws-stale-session-fix.json +41 -0
- package/ftm-state/blackboard/patterns.json +6 -6
- package/ftm-state/schemas/context.schema.json +130 -130
- package/ftm-state/schemas/experience-index.schema.json +77 -77
- package/ftm-state/schemas/experience.schema.json +78 -78
- package/ftm-state/schemas/patterns.schema.json +44 -44
- package/ftm-upgrade/SKILL.md +194 -194
- package/ftm-upgrade/scripts/check-version.sh +76 -76
- package/ftm-upgrade/scripts/upgrade.sh +143 -143
- package/ftm-upgrade.yml +2 -2
- package/ftm-verify.yml +2 -2
- package/ftm.yml +2 -2
- package/hooks/ftm-auto-log.sh +137 -0
- package/hooks/ftm-blackboard-enforcer.sh +93 -93
- package/hooks/ftm-discovery-reminder.sh +90 -90
- package/hooks/ftm-drafts-gate.sh +61 -61
- package/hooks/ftm-event-logger.mjs +107 -107
- package/hooks/ftm-install-hooks.sh +240 -0
- package/hooks/ftm-learning-capture.sh +117 -0
- package/hooks/ftm-map-autodetect.sh +79 -79
- package/hooks/ftm-pending-sync-check.sh +22 -22
- package/hooks/ftm-plan-gate.sh +92 -92
- package/hooks/ftm-post-commit-trigger.sh +57 -57
- package/hooks/ftm-post-compaction.sh +138 -0
- package/hooks/ftm-pre-compaction.sh +147 -0
- package/hooks/ftm-session-end.sh +52 -0
- package/hooks/ftm-session-snapshot.sh +213 -0
- package/hooks/settings-template.json +81 -81
- package/install.sh +363 -363
- package/package.json +84 -84
- package/uninstall.sh +25 -25
package/ftm-map/SKILL.md
CHANGED
|
@@ -1,291 +1,291 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: ftm-map
|
|
3
|
-
description: Persistent code knowledge graph powered by tree-sitter and SQLite with FTS5 full-text search. Uses a v2 hybrid architecture combining file-level PageRank with symbol-level blast radius analysis. Builds structural dependency graphs for blast radius, dependency chains, context selection, and keyword search. Use when user asks "what breaks if I change X", "blast radius", "what depends on", "where do we handle", "map codebase", "index project", "what calls", "dependency chain", "what's relevant for", "context for", "ftm-map".
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# ftm-map
|
|
7
|
-
|
|
8
|
-
Persistent code knowledge graph powered by tree-sitter and SQLite with FTS5 full-text search. Uses a v2 hybrid architecture: file-level PageRank (via fast-pagerank with scipy sparse matrices) for broad relevance ranking, combined with symbol-level blast radius for precise impact analysis. Parses the local codebase using Aider-style def/ref extraction with tags.scm into a 5-table schema (files, symbols, refs, file_edges, symbol_edges) stored in `.ftm-map/map.db`, then answers structural queries (blast radius, dependency chains, context selection, symbol lookup) and keyword searches without re-reading the source tree on every question.
|
|
9
|
-
|
|
10
|
-
## Events
|
|
11
|
-
|
|
12
|
-
### Emits
|
|
13
|
-
- `map_updated` — when the graph database has been updated (bootstrap or incremental)
|
|
14
|
-
- Payload: `{ project_path, symbols_count, edges_count, file_edges_count, reference_count, files_parsed, duration_ms, mode }`
|
|
15
|
-
- `task_completed` — when any ftm-map operation finishes
|
|
16
|
-
|
|
17
|
-
### Listens To
|
|
18
|
-
- `code_committed` — run incremental index on changed files, then emit `map_updated`
|
|
19
|
-
- `task_received` — begin bootstrap or query when ftm-mind routes a mapping/search request
|
|
20
|
-
|
|
21
|
-
## Config Read
|
|
22
|
-
|
|
23
|
-
Read `~/.claude/ftm-config.yml`:
|
|
24
|
-
- Check `skills.ftm-map.enabled` (default: true)
|
|
25
|
-
- Use `execution` model from active profile for indexing agents
|
|
26
|
-
|
|
27
|
-
## Blackboard Read
|
|
28
|
-
|
|
29
|
-
On startup, load context from the FTM blackboard:
|
|
30
|
-
1. Load `~/.claude/ftm-blackboard/context.json`
|
|
31
|
-
2. Filter experiences by `task_type: "map"`
|
|
32
|
-
3. Load matching experience files to inform index scope and query routing
|
|
33
|
-
4. Check for prior bootstrap records to determine if incremental mode is appropriate
|
|
34
|
-
|
|
35
|
-
## Mode Detection
|
|
36
|
-
|
|
37
|
-
Three modes, detected from request context:
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
Bootstrap: "map this codebase" / "index this project" / no map.db exists yet
|
|
41
|
-
Full scan of all source files. Builds graph from scratch.
|
|
42
|
-
|
|
43
|
-
Incremental: Triggered by code_committed event or PostToolUse hook
|
|
44
|
-
Parses only changed files and updates their graph entries.
|
|
45
|
-
|
|
46
|
-
Query: Structural, keyword, or context question about existing graph
|
|
47
|
-
Detects query type and runs appropriate script.
|
|
48
|
-
Includes context selection for token-budgeted file retrieval.
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
If `.ftm-map/map.db` does not exist when a query arrives, fall back to offering bootstrap (see Graceful Degradation below).
|
|
52
|
-
|
|
53
|
-
## Mode 1: Bootstrap (full scan)
|
|
54
|
-
|
|
55
|
-
Trigger: user says "map this codebase" or "index this project", or `.ftm-map/map.db` does not yet exist.
|
|
56
|
-
|
|
57
|
-
1. Run `ftm-map/scripts/setup.sh` to ensure virtualenv and tree-sitter dependencies are installed
|
|
58
|
-
2. Run `ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/index.py --bootstrap <project_root>`
|
|
59
|
-
3. Capture and report stats from stdout:
|
|
60
|
-
- Files parsed
|
|
61
|
-
- Symbols found
|
|
62
|
-
- Edges created
|
|
63
|
-
- Time elapsed
|
|
64
|
-
4. Emit `map_updated` with `mode: "bootstrap"`
|
|
65
|
-
|
|
66
|
-
Example invocation:
|
|
67
|
-
```
|
|
68
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/index.py --bootstrap .
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## Mode 2: Incremental (post-commit)
|
|
72
|
-
|
|
73
|
-
Trigger: `code_committed` event fires, or PostToolUse hook detects a write to a source file.
|
|
74
|
-
|
|
75
|
-
1. Get changed files:
|
|
76
|
-
```
|
|
77
|
-
git diff --name-only HEAD~1
|
|
78
|
-
```
|
|
79
|
-
2. Filter to source files only (skip docs, configs, lockfiles)
|
|
80
|
-
3. Run incremental index on changed files:
|
|
81
|
-
```
|
|
82
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/index.py --incremental --files <file1> <file2> ...
|
|
83
|
-
```
|
|
84
|
-
4. Emit `map_updated` with `mode: "incremental"` and count of updated entries
|
|
85
|
-
|
|
86
|
-
## Mode 3: Query (answer structural and search questions)
|
|
87
|
-
|
|
88
|
-
Trigger: user asks a structural or keyword question about the codebase.
|
|
89
|
-
|
|
90
|
-
### Query Type Detection
|
|
91
|
-
|
|
92
|
-
| User says | Query type | Script flag |
|
|
93
|
-
|-----------|-----------|-------------|
|
|
94
|
-
| "what breaks if I change X" | blast radius | `--blast-radius X` |
|
|
95
|
-
| "blast radius of X" | blast radius | `--blast-radius X` |
|
|
96
|
-
| "what depends on X" | dependency chain | `--deps X` |
|
|
97
|
-
| "what calls X" | dependency chain (callers) | `--deps X` |
|
|
98
|
-
| "where do we handle X" | FTS5 keyword search | `--search "X"` |
|
|
99
|
-
| "find X in the codebase" | FTS5 keyword search | `--search "X"` |
|
|
100
|
-
| "tell me about function X" | symbol info | `--info X` |
|
|
101
|
-
| "show dependencies for X" | dependency chain | `--deps X` |
|
|
102
|
-
| "what's relevant for X" | context selection | `--context --seed-keywords X` |
|
|
103
|
-
| "context for X" | context selection | `--context --seed-keywords X` |
|
|
104
|
-
| "important files for X" | context selection | `--context --seed-files X` |
|
|
105
|
-
| "what should I look at for X" | context selection | `--context --seed-keywords X` |
|
|
106
|
-
| "show stats" / "how big is the index" | statistics | `--stats` |
|
|
107
|
-
|
|
108
|
-
### Execution
|
|
109
|
-
|
|
110
|
-
Run the appropriate query script with the venv python:
|
|
111
|
-
```
|
|
112
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --blast-radius <symbol> --project-root .
|
|
113
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --deps <symbol> --project-root .
|
|
114
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --search "<keywords>" --project-root .
|
|
115
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --info <symbol> --project-root .
|
|
116
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --context --seed-files src/auth.py --token-budget 4000 --project-root .
|
|
117
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --context --seed-keywords authenticate --project-root .
|
|
118
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --context --seed-symbols handleAuth --token-budget 8000 --project-root .
|
|
119
|
-
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --stats --project-root .
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### Output Formatting
|
|
123
|
-
|
|
124
|
-
Scripts return JSON. Render as readable markdown:
|
|
125
|
-
|
|
126
|
-
**Blast radius** — tree of affected symbols with file paths and line numbers:
|
|
127
|
-
```
|
|
128
|
-
Blast radius of `authenticateUser`:
|
|
129
|
-
direct callers (3):
|
|
130
|
-
• loginHandler src/handlers/auth.ts:42
|
|
131
|
-
• refreshSession src/handlers/session.ts:17
|
|
132
|
-
• testAuthFlow src/tests/auth.test.ts:88
|
|
133
|
-
transitive (5):
|
|
134
|
-
• routeMiddleware src/middleware/index.ts:12
|
|
135
|
-
...
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
**Dependency chain** — ordered list of dependencies (callee direction):
|
|
139
|
-
```
|
|
140
|
-
Dependencies of `authenticateUser`:
|
|
141
|
-
1. validateToken src/auth/tokens.ts:8
|
|
142
|
-
2. decodeJWT src/auth/jwt.ts:22
|
|
143
|
-
3. createSession src/auth/session.ts:45
|
|
144
|
-
4. storeSession src/auth/session.ts:67
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
**FTS5 search** — BM25-ranked list with file:line references:
|
|
148
|
-
```
|
|
149
|
-
Results for "rate limit" (6 matches, ranked by relevance):
|
|
150
|
-
1. applyRateLimit src/middleware/ratelimit.ts:14 score: 0.94
|
|
151
|
-
2. RateLimitConfig src/config/types.ts:88 score: 0.81
|
|
152
|
-
3. checkRateLimit src/handlers/base.ts:203 score: 0.77
|
|
153
|
-
...
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
**Symbol info** — full details card:
|
|
157
|
-
```
|
|
158
|
-
Symbol: authenticateUser
|
|
159
|
-
Kind: function
|
|
160
|
-
File: src/auth/index.ts:34
|
|
161
|
-
Signature: authenticateUser(token: string, opts?: AuthOptions) → Promise<Session>
|
|
162
|
-
Callers: 3 direct, 5 transitive
|
|
163
|
-
Callees: validateToken, decodeJWT, createSession
|
|
164
|
-
References: 12 across codebase
|
|
165
|
-
Dependents: 8 symbols total
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
**Context selection** — PageRank-ranked files with token budget:
|
|
169
|
-
```
|
|
170
|
-
Context for "authenticate" (budget: 4000 tokens):
|
|
171
|
-
1. src/auth/index.ts score: 0.142 tokens: 850
|
|
172
|
-
2. src/handlers/auth.ts score: 0.098 tokens: 620
|
|
173
|
-
3. src/middleware/session.ts score: 0.076 tokens: 540
|
|
174
|
-
Total: 2010 / 4000 tokens
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
**Stats** — database overview:
|
|
178
|
-
```
|
|
179
|
-
Index statistics:
|
|
180
|
-
Files: 42
|
|
181
|
-
Symbols: 318
|
|
182
|
-
References: 1204
|
|
183
|
-
File edges: 86
|
|
184
|
-
Symbol edges: 542
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
## Graceful Degradation
|
|
188
|
-
|
|
189
|
-
If `.ftm-map/map.db` does not exist when a query is requested:
|
|
190
|
-
|
|
191
|
-
1. Explain that the graph has not been indexed yet
|
|
192
|
-
2. Offer to bootstrap: "Run `ftm-map bootstrap` to index this codebase?"
|
|
193
|
-
3. If user confirms, switch to Bootstrap mode immediately
|
|
194
|
-
4. Do not attempt to answer structural queries by reading source files directly — the graph is the source of truth for structural questions
|
|
195
|
-
|
|
196
|
-
## Python Script Interface
|
|
197
|
-
|
|
198
|
-
All heavy lifting is done by Python scripts in `ftm-map/scripts/`. The skill orchestrates: detects mode, runs the right script with venv python, formats the output.
|
|
199
|
-
|
|
200
|
-
| Script | Purpose |
|
|
201
|
-
|--------|---------|
|
|
202
|
-
| `setup.sh` | Creates virtualenv, installs tree-sitter and dependencies |
|
|
203
|
-
| `db.py` | 5-table SQLite schema (files, symbols, refs, file_edges, symbol_edges), CRUD, graph traversal |
|
|
204
|
-
| `parser.py` | Aider-style def/ref extraction via tree-sitter tags.scm queries |
|
|
205
|
-
| `index.py` | Full bootstrap scan and incremental file indexing with Aider weight heuristics |
|
|
206
|
-
| `query.py` | Blast radius, dependency chain, FTS5 search, symbol info, context selection, stats |
|
|
207
|
-
| `ranker.py` | PageRank-based file ranking with fast-pagerank and scipy sparse matrices |
|
|
208
|
-
| `views.py` | INTENT.md and ARCHITECTURE.mmd generation from the 5-table graph |
|
|
209
|
-
|
|
210
|
-
Always use the venv python — never the system python — to ensure tree-sitter bindings are available:
|
|
211
|
-
```
|
|
212
|
-
ftm-map/scripts/.venv/bin/python3 <script> <args>
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
## Integration Points
|
|
216
|
-
|
|
217
|
-
**ftm-intent** may call ftm-map to retrieve caller/callee relationships when writing the `Relationships` field of INTENT.md entries. ftm-map returns structured JSON that ftm-intent formats into human-readable relationship text.
|
|
218
|
-
|
|
219
|
-
**ftm-diagram** may call ftm-map to retrieve the dependency graph for a module when generating DIAGRAM.mmd files. ftm-map returns edge data that ftm-diagram renders as mermaid nodes and edges.
|
|
220
|
-
|
|
221
|
-
Both integrations use `query.py --deps` and `query.py --info` to retrieve graph data without re-parsing source.
|
|
222
|
-
|
|
223
|
-
## Blackboard Write
|
|
224
|
-
|
|
225
|
-
After `map_updated` or session end:
|
|
226
|
-
1. Update `~/.claude/ftm-blackboard/context.json` with map session summary
|
|
227
|
-
2. Write experience file: `~/.claude/ftm-blackboard/experiences/map-[timestamp].json`
|
|
228
|
-
- Fields: project_path, mode, symbols_count, edges_count, files_parsed, duration_ms
|
|
229
|
-
3. Update `~/.claude/ftm-blackboard/index.json` with new experience entry
|
|
230
|
-
4. Emit `task_completed` event
|
|
231
|
-
|
|
232
|
-
## Rules
|
|
233
|
-
|
|
234
|
-
- NEVER stop to ask for input. Make decisions and keep going.
|
|
235
|
-
- ALWAYS commit after completing with a clear message.
|
|
236
|
-
- ALWAYS review after commit: run `git diff HEAD~1`.
|
|
237
|
-
- Never reference AI/Claude in commit messages.
|
|
238
|
-
- Stay in your worktree.
|
|
239
|
-
- ALWAYS use the venv python (`ftm-map/scripts/.venv/bin/python3`), never the system python.
|
|
240
|
-
- For query mode, ALWAYS run `setup.sh` first if `.venv` does not exist.
|
|
241
|
-
|
|
242
|
-
## Requirements
|
|
243
|
-
|
|
244
|
-
- tool: `ftm-map/scripts/.venv/bin/python3` | required | Python with tree-sitter and SQLite bindings
|
|
245
|
-
- tool: `ftm-map/scripts/setup.sh` | required | virtualenv and dependency installer
|
|
246
|
-
- tool: `ftm-map/scripts/index.py` | required | bootstrap and incremental indexer
|
|
247
|
-
- tool: `ftm-map/scripts/query.py` | required | blast radius, dependency, and FTS5 search queries
|
|
248
|
-
- tool: `ftm-map/scripts/views.py` | required | INTENT.md and .mmd diagram generation from graph
|
|
249
|
-
- tool: `ftm-map/scripts/ranker.py` | required | PageRank file ranking with fast-pagerank and scipy
|
|
250
|
-
- tool: `git` | optional | changed file detection for incremental mode
|
|
251
|
-
- config: `~/.claude/ftm-config.yml` | optional | model profile and skills.ftm-map.enabled flag
|
|
252
|
-
|
|
253
|
-
## Risk
|
|
254
|
-
|
|
255
|
-
- level: low_write
|
|
256
|
-
- scope: writes and updates .ftm-map/map.db SQLite database; does not modify any project source files; also writes blackboard experience entry
|
|
257
|
-
- rollback: delete .ftm-map/map.db to reset to unindexed state; re-run bootstrap to rebuild
|
|
258
|
-
|
|
259
|
-
## Approval Gates
|
|
260
|
-
|
|
261
|
-
- trigger: bootstrap requested on very large codebase (1000+ files) | action: report estimated file count before running, proceed unless user objects
|
|
262
|
-
- complexity_routing: micro → auto | small → auto | medium → auto | large → auto | xl → auto
|
|
263
|
-
|
|
264
|
-
## Fallbacks
|
|
265
|
-
|
|
266
|
-
- condition: .venv does not exist | action: run setup.sh first to create it before proceeding
|
|
267
|
-
- condition: tree-sitter binary missing | action: run setup.sh to install dependencies
|
|
268
|
-
- condition: .ftm-map/map.db missing when query requested | action: explain graph not indexed, offer to run bootstrap
|
|
269
|
-
- condition: git not available for incremental changed-file detection | action: fall back to indexing all modified files detected from disk timestamps
|
|
270
|
-
|
|
271
|
-
## Capabilities
|
|
272
|
-
|
|
273
|
-
- cli: `ftm-map/scripts/.venv/bin/python3` | required | tree-sitter parsing and SQLite operations
|
|
274
|
-
- cli: `git` | optional | changed file detection for incremental indexing
|
|
275
|
-
|
|
276
|
-
## Event Payloads
|
|
277
|
-
|
|
278
|
-
### map_updated
|
|
279
|
-
- skill: string — "ftm-map"
|
|
280
|
-
- project_path: string — absolute path to indexed project
|
|
281
|
-
- symbols_count: number — total symbols in the graph
|
|
282
|
-
- edges_count: number — total dependency edges
|
|
283
|
-
- files_parsed: number — files processed in this operation
|
|
284
|
-
- duration_ms: number — indexing duration
|
|
285
|
-
- mode: string — "bootstrap" | "incremental"
|
|
286
|
-
|
|
287
|
-
### task_completed
|
|
288
|
-
- skill: string — "ftm-map"
|
|
289
|
-
- operation: string — "bootstrap" | "incremental" | "query"
|
|
290
|
-
- query_type: string | null — "blast-radius" | "deps" | "search" | "info" | "context" | "stats" (for query mode)
|
|
291
|
-
- duration_ms: number — total operation duration
|
|
1
|
+
---
|
|
2
|
+
name: ftm-map
|
|
3
|
+
description: Persistent code knowledge graph powered by tree-sitter and SQLite with FTS5 full-text search. Uses a v2 hybrid architecture combining file-level PageRank with symbol-level blast radius analysis. Builds structural dependency graphs for blast radius, dependency chains, context selection, and keyword search. Use when user asks "what breaks if I change X", "blast radius", "what depends on", "where do we handle", "map codebase", "index project", "what calls", "dependency chain", "what's relevant for", "context for", "ftm-map".
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# ftm-map
|
|
7
|
+
|
|
8
|
+
Persistent code knowledge graph powered by tree-sitter and SQLite with FTS5 full-text search. Uses a v2 hybrid architecture: file-level PageRank (via fast-pagerank with scipy sparse matrices) for broad relevance ranking, combined with symbol-level blast radius for precise impact analysis. Parses the local codebase using Aider-style def/ref extraction with tags.scm into a 5-table schema (files, symbols, refs, file_edges, symbol_edges) stored in `.ftm-map/map.db`, then answers structural queries (blast radius, dependency chains, context selection, symbol lookup) and keyword searches without re-reading the source tree on every question.
|
|
9
|
+
|
|
10
|
+
## Events
|
|
11
|
+
|
|
12
|
+
### Emits
|
|
13
|
+
- `map_updated` — when the graph database has been updated (bootstrap or incremental)
|
|
14
|
+
- Payload: `{ project_path, symbols_count, edges_count, file_edges_count, reference_count, files_parsed, duration_ms, mode }`
|
|
15
|
+
- `task_completed` — when any ftm-map operation finishes
|
|
16
|
+
|
|
17
|
+
### Listens To
|
|
18
|
+
- `code_committed` — run incremental index on changed files, then emit `map_updated`
|
|
19
|
+
- `task_received` — begin bootstrap or query when ftm-mind routes a mapping/search request
|
|
20
|
+
|
|
21
|
+
## Config Read
|
|
22
|
+
|
|
23
|
+
Read `~/.claude/ftm-config.yml`:
|
|
24
|
+
- Check `skills.ftm-map.enabled` (default: true)
|
|
25
|
+
- Use `execution` model from active profile for indexing agents
|
|
26
|
+
|
|
27
|
+
## Blackboard Read
|
|
28
|
+
|
|
29
|
+
On startup, load context from the FTM blackboard:
|
|
30
|
+
1. Load `~/.claude/ftm-blackboard/context.json`
|
|
31
|
+
2. Filter experiences by `task_type: "map"`
|
|
32
|
+
3. Load matching experience files to inform index scope and query routing
|
|
33
|
+
4. Check for prior bootstrap records to determine if incremental mode is appropriate
|
|
34
|
+
|
|
35
|
+
## Mode Detection
|
|
36
|
+
|
|
37
|
+
Three modes, detected from request context:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
Bootstrap: "map this codebase" / "index this project" / no map.db exists yet
|
|
41
|
+
Full scan of all source files. Builds graph from scratch.
|
|
42
|
+
|
|
43
|
+
Incremental: Triggered by code_committed event or PostToolUse hook
|
|
44
|
+
Parses only changed files and updates their graph entries.
|
|
45
|
+
|
|
46
|
+
Query: Structural, keyword, or context question about existing graph
|
|
47
|
+
Detects query type and runs appropriate script.
|
|
48
|
+
Includes context selection for token-budgeted file retrieval.
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
If `.ftm-map/map.db` does not exist when a query arrives, fall back to offering bootstrap (see Graceful Degradation below).
|
|
52
|
+
|
|
53
|
+
## Mode 1: Bootstrap (full scan)
|
|
54
|
+
|
|
55
|
+
Trigger: user says "map this codebase" or "index this project", or `.ftm-map/map.db` does not yet exist.
|
|
56
|
+
|
|
57
|
+
1. Run `ftm-map/scripts/setup.sh` to ensure virtualenv and tree-sitter dependencies are installed
|
|
58
|
+
2. Run `ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/index.py --bootstrap <project_root>`
|
|
59
|
+
3. Capture and report stats from stdout:
|
|
60
|
+
- Files parsed
|
|
61
|
+
- Symbols found
|
|
62
|
+
- Edges created
|
|
63
|
+
- Time elapsed
|
|
64
|
+
4. Emit `map_updated` with `mode: "bootstrap"`
|
|
65
|
+
|
|
66
|
+
Example invocation:
|
|
67
|
+
```
|
|
68
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/index.py --bootstrap .
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Mode 2: Incremental (post-commit)
|
|
72
|
+
|
|
73
|
+
Trigger: `code_committed` event fires, or PostToolUse hook detects a write to a source file.
|
|
74
|
+
|
|
75
|
+
1. Get changed files:
|
|
76
|
+
```
|
|
77
|
+
git diff --name-only HEAD~1
|
|
78
|
+
```
|
|
79
|
+
2. Filter to source files only (skip docs, configs, lockfiles)
|
|
80
|
+
3. Run incremental index on changed files:
|
|
81
|
+
```
|
|
82
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/index.py --incremental --files <file1> <file2> ...
|
|
83
|
+
```
|
|
84
|
+
4. Emit `map_updated` with `mode: "incremental"` and count of updated entries
|
|
85
|
+
|
|
86
|
+
## Mode 3: Query (answer structural and search questions)
|
|
87
|
+
|
|
88
|
+
Trigger: user asks a structural or keyword question about the codebase.
|
|
89
|
+
|
|
90
|
+
### Query Type Detection
|
|
91
|
+
|
|
92
|
+
| User says | Query type | Script flag |
|
|
93
|
+
|-----------|-----------|-------------|
|
|
94
|
+
| "what breaks if I change X" | blast radius | `--blast-radius X` |
|
|
95
|
+
| "blast radius of X" | blast radius | `--blast-radius X` |
|
|
96
|
+
| "what depends on X" | dependency chain | `--deps X` |
|
|
97
|
+
| "what calls X" | dependency chain (callers) | `--deps X` |
|
|
98
|
+
| "where do we handle X" | FTS5 keyword search | `--search "X"` |
|
|
99
|
+
| "find X in the codebase" | FTS5 keyword search | `--search "X"` |
|
|
100
|
+
| "tell me about function X" | symbol info | `--info X` |
|
|
101
|
+
| "show dependencies for X" | dependency chain | `--deps X` |
|
|
102
|
+
| "what's relevant for X" | context selection | `--context --seed-keywords X` |
|
|
103
|
+
| "context for X" | context selection | `--context --seed-keywords X` |
|
|
104
|
+
| "important files for X" | context selection | `--context --seed-files X` |
|
|
105
|
+
| "what should I look at for X" | context selection | `--context --seed-keywords X` |
|
|
106
|
+
| "show stats" / "how big is the index" | statistics | `--stats` |
|
|
107
|
+
|
|
108
|
+
### Execution
|
|
109
|
+
|
|
110
|
+
Run the appropriate query script with the venv python:
|
|
111
|
+
```
|
|
112
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --blast-radius <symbol> --project-root .
|
|
113
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --deps <symbol> --project-root .
|
|
114
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --search "<keywords>" --project-root .
|
|
115
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --info <symbol> --project-root .
|
|
116
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --context --seed-files src/auth.py --token-budget 4000 --project-root .
|
|
117
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --context --seed-keywords authenticate --project-root .
|
|
118
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --context --seed-symbols handleAuth --token-budget 8000 --project-root .
|
|
119
|
+
ftm-map/scripts/.venv/bin/python3 ftm-map/scripts/query.py --stats --project-root .
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Output Formatting
|
|
123
|
+
|
|
124
|
+
Scripts return JSON. Render as readable markdown:
|
|
125
|
+
|
|
126
|
+
**Blast radius** — tree of affected symbols with file paths and line numbers:
|
|
127
|
+
```
|
|
128
|
+
Blast radius of `authenticateUser`:
|
|
129
|
+
direct callers (3):
|
|
130
|
+
• loginHandler src/handlers/auth.ts:42
|
|
131
|
+
• refreshSession src/handlers/session.ts:17
|
|
132
|
+
• testAuthFlow src/tests/auth.test.ts:88
|
|
133
|
+
transitive (5):
|
|
134
|
+
• routeMiddleware src/middleware/index.ts:12
|
|
135
|
+
...
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
**Dependency chain** — ordered list of dependencies (callee direction):
|
|
139
|
+
```
|
|
140
|
+
Dependencies of `authenticateUser`:
|
|
141
|
+
1. validateToken src/auth/tokens.ts:8
|
|
142
|
+
2. decodeJWT src/auth/jwt.ts:22
|
|
143
|
+
3. createSession src/auth/session.ts:45
|
|
144
|
+
4. storeSession src/auth/session.ts:67
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
**FTS5 search** — BM25-ranked list with file:line references:
|
|
148
|
+
```
|
|
149
|
+
Results for "rate limit" (6 matches, ranked by relevance):
|
|
150
|
+
1. applyRateLimit src/middleware/ratelimit.ts:14 score: 0.94
|
|
151
|
+
2. RateLimitConfig src/config/types.ts:88 score: 0.81
|
|
152
|
+
3. checkRateLimit src/handlers/base.ts:203 score: 0.77
|
|
153
|
+
...
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
**Symbol info** — full details card:
|
|
157
|
+
```
|
|
158
|
+
Symbol: authenticateUser
|
|
159
|
+
Kind: function
|
|
160
|
+
File: src/auth/index.ts:34
|
|
161
|
+
Signature: authenticateUser(token: string, opts?: AuthOptions) → Promise<Session>
|
|
162
|
+
Callers: 3 direct, 5 transitive
|
|
163
|
+
Callees: validateToken, decodeJWT, createSession
|
|
164
|
+
References: 12 across codebase
|
|
165
|
+
Dependents: 8 symbols total
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
**Context selection** — PageRank-ranked files with token budget:
|
|
169
|
+
```
|
|
170
|
+
Context for "authenticate" (budget: 4000 tokens):
|
|
171
|
+
1. src/auth/index.ts score: 0.142 tokens: 850
|
|
172
|
+
2. src/handlers/auth.ts score: 0.098 tokens: 620
|
|
173
|
+
3. src/middleware/session.ts score: 0.076 tokens: 540
|
|
174
|
+
Total: 2010 / 4000 tokens
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**Stats** — database overview:
|
|
178
|
+
```
|
|
179
|
+
Index statistics:
|
|
180
|
+
Files: 42
|
|
181
|
+
Symbols: 318
|
|
182
|
+
References: 1204
|
|
183
|
+
File edges: 86
|
|
184
|
+
Symbol edges: 542
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
## Graceful Degradation
|
|
188
|
+
|
|
189
|
+
If `.ftm-map/map.db` does not exist when a query is requested:
|
|
190
|
+
|
|
191
|
+
1. Explain that the graph has not been indexed yet
|
|
192
|
+
2. Offer to bootstrap: "Run `ftm-map bootstrap` to index this codebase?"
|
|
193
|
+
3. If user confirms, switch to Bootstrap mode immediately
|
|
194
|
+
4. Do not attempt to answer structural queries by reading source files directly — the graph is the source of truth for structural questions
|
|
195
|
+
|
|
196
|
+
## Python Script Interface
|
|
197
|
+
|
|
198
|
+
All heavy lifting is done by Python scripts in `ftm-map/scripts/`. The skill orchestrates: detects mode, runs the right script with venv python, formats the output.
|
|
199
|
+
|
|
200
|
+
| Script | Purpose |
|
|
201
|
+
|--------|---------|
|
|
202
|
+
| `setup.sh` | Creates virtualenv, installs tree-sitter and dependencies |
|
|
203
|
+
| `db.py` | 5-table SQLite schema (files, symbols, refs, file_edges, symbol_edges), CRUD, graph traversal |
|
|
204
|
+
| `parser.py` | Aider-style def/ref extraction via tree-sitter tags.scm queries |
|
|
205
|
+
| `index.py` | Full bootstrap scan and incremental file indexing with Aider weight heuristics |
|
|
206
|
+
| `query.py` | Blast radius, dependency chain, FTS5 search, symbol info, context selection, stats |
|
|
207
|
+
| `ranker.py` | PageRank-based file ranking with fast-pagerank and scipy sparse matrices |
|
|
208
|
+
| `views.py` | INTENT.md and ARCHITECTURE.mmd generation from the 5-table graph |
|
|
209
|
+
|
|
210
|
+
Always use the venv python — never the system python — to ensure tree-sitter bindings are available:
|
|
211
|
+
```
|
|
212
|
+
ftm-map/scripts/.venv/bin/python3 <script> <args>
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
## Integration Points
|
|
216
|
+
|
|
217
|
+
**ftm-intent** may call ftm-map to retrieve caller/callee relationships when writing the `Relationships` field of INTENT.md entries. ftm-map returns structured JSON that ftm-intent formats into human-readable relationship text.
|
|
218
|
+
|
|
219
|
+
**ftm-diagram** may call ftm-map to retrieve the dependency graph for a module when generating DIAGRAM.mmd files. ftm-map returns edge data that ftm-diagram renders as mermaid nodes and edges.
|
|
220
|
+
|
|
221
|
+
Both integrations use `query.py --deps` and `query.py --info` to retrieve graph data without re-parsing source.
|
|
222
|
+
|
|
223
|
+
## Blackboard Write
|
|
224
|
+
|
|
225
|
+
After `map_updated` or session end:
|
|
226
|
+
1. Update `~/.claude/ftm-blackboard/context.json` with map session summary
|
|
227
|
+
2. Write experience file: `~/.claude/ftm-blackboard/experiences/map-[timestamp].json`
|
|
228
|
+
- Fields: project_path, mode, symbols_count, edges_count, files_parsed, duration_ms
|
|
229
|
+
3. Update `~/.claude/ftm-blackboard/index.json` with new experience entry
|
|
230
|
+
4. Emit `task_completed` event
|
|
231
|
+
|
|
232
|
+
## Rules
|
|
233
|
+
|
|
234
|
+
- NEVER stop to ask for input. Make decisions and keep going.
|
|
235
|
+
- ALWAYS commit after completing with a clear message.
|
|
236
|
+
- ALWAYS review after commit: run `git diff HEAD~1`.
|
|
237
|
+
- Never reference AI/Claude in commit messages.
|
|
238
|
+
- Stay in your worktree.
|
|
239
|
+
- ALWAYS use the venv python (`ftm-map/scripts/.venv/bin/python3`), never the system python.
|
|
240
|
+
- For query mode, ALWAYS run `setup.sh` first if `.venv` does not exist.
|
|
241
|
+
|
|
242
|
+
## Requirements
|
|
243
|
+
|
|
244
|
+
- tool: `ftm-map/scripts/.venv/bin/python3` | required | Python with tree-sitter and SQLite bindings
|
|
245
|
+
- tool: `ftm-map/scripts/setup.sh` | required | virtualenv and dependency installer
|
|
246
|
+
- tool: `ftm-map/scripts/index.py` | required | bootstrap and incremental indexer
|
|
247
|
+
- tool: `ftm-map/scripts/query.py` | required | blast radius, dependency, and FTS5 search queries
|
|
248
|
+
- tool: `ftm-map/scripts/views.py` | required | INTENT.md and .mmd diagram generation from graph
|
|
249
|
+
- tool: `ftm-map/scripts/ranker.py` | required | PageRank file ranking with fast-pagerank and scipy
|
|
250
|
+
- tool: `git` | optional | changed file detection for incremental mode
|
|
251
|
+
- config: `~/.claude/ftm-config.yml` | optional | model profile and skills.ftm-map.enabled flag
|
|
252
|
+
|
|
253
|
+
## Risk
|
|
254
|
+
|
|
255
|
+
- level: low_write
|
|
256
|
+
- scope: writes and updates .ftm-map/map.db SQLite database; does not modify any project source files; also writes blackboard experience entry
|
|
257
|
+
- rollback: delete .ftm-map/map.db to reset to unindexed state; re-run bootstrap to rebuild
|
|
258
|
+
|
|
259
|
+
## Approval Gates
|
|
260
|
+
|
|
261
|
+
- trigger: bootstrap requested on very large codebase (1000+ files) | action: report estimated file count before running, proceed unless user objects
|
|
262
|
+
- complexity_routing: micro → auto | small → auto | medium → auto | large → auto | xl → auto
|
|
263
|
+
|
|
264
|
+
## Fallbacks
|
|
265
|
+
|
|
266
|
+
- condition: .venv does not exist | action: run setup.sh first to create it before proceeding
|
|
267
|
+
- condition: tree-sitter binary missing | action: run setup.sh to install dependencies
|
|
268
|
+
- condition: .ftm-map/map.db missing when query requested | action: explain graph not indexed, offer to run bootstrap
|
|
269
|
+
- condition: git not available for incremental changed-file detection | action: fall back to indexing all modified files detected from disk timestamps
|
|
270
|
+
|
|
271
|
+
## Capabilities
|
|
272
|
+
|
|
273
|
+
- cli: `ftm-map/scripts/.venv/bin/python3` | required | tree-sitter parsing and SQLite operations
|
|
274
|
+
- cli: `git` | optional | changed file detection for incremental indexing
|
|
275
|
+
|
|
276
|
+
## Event Payloads
|
|
277
|
+
|
|
278
|
+
### map_updated
|
|
279
|
+
- skill: string — "ftm-map"
|
|
280
|
+
- project_path: string — absolute path to indexed project
|
|
281
|
+
- symbols_count: number — total symbols in the graph
|
|
282
|
+
- edges_count: number — total dependency edges
|
|
283
|
+
- files_parsed: number — files processed in this operation
|
|
284
|
+
- duration_ms: number — indexing duration
|
|
285
|
+
- mode: string — "bootstrap" | "incremental"
|
|
286
|
+
|
|
287
|
+
### task_completed
|
|
288
|
+
- skill: string — "ftm-map"
|
|
289
|
+
- operation: string — "bootstrap" | "incremental" | "query"
|
|
290
|
+
- query_type: string | null — "blast-radius" | "deps" | "search" | "info" | "context" | "stats" (for query mode)
|
|
291
|
+
- duration_ms: number — total operation duration
|