@jcode.labs/ragmir 2.2.0 → 2.4.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.
Files changed (59) hide show
  1. package/README.md +23 -17
  2. package/dist/cli.js +100 -20
  3. package/dist/cli.js.map +1 -1
  4. package/dist/config.d.ts.map +1 -1
  5. package/dist/config.js +3 -0
  6. package/dist/config.js.map +1 -1
  7. package/dist/defaults.d.ts.map +1 -1
  8. package/dist/defaults.js +1 -0
  9. package/dist/defaults.js.map +1 -1
  10. package/dist/doctor.d.ts.map +1 -1
  11. package/dist/doctor.js +26 -8
  12. package/dist/doctor.js.map +1 -1
  13. package/dist/index-diagnostics.d.ts +26 -0
  14. package/dist/index-diagnostics.d.ts.map +1 -0
  15. package/dist/index-diagnostics.js +49 -0
  16. package/dist/index-diagnostics.js.map +1 -0
  17. package/dist/index.d.ts +5 -2
  18. package/dist/index.d.ts.map +1 -1
  19. package/dist/index.js +3 -1
  20. package/dist/index.js.map +1 -1
  21. package/dist/ingest.d.ts.map +1 -1
  22. package/dist/ingest.js +18 -2
  23. package/dist/ingest.js.map +1 -1
  24. package/dist/mcp.d.ts.map +1 -1
  25. package/dist/mcp.js +9 -0
  26. package/dist/mcp.js.map +1 -1
  27. package/dist/package-manager.d.ts +3 -2
  28. package/dist/package-manager.d.ts.map +1 -1
  29. package/dist/package-manager.js +12 -11
  30. package/dist/package-manager.js.map +1 -1
  31. package/dist/prompt-routing.d.ts +12 -0
  32. package/dist/prompt-routing.d.ts.map +1 -0
  33. package/dist/prompt-routing.js +150 -0
  34. package/dist/prompt-routing.js.map +1 -0
  35. package/dist/query.d.ts.map +1 -1
  36. package/dist/query.js +6 -3
  37. package/dist/query.js.map +1 -1
  38. package/dist/research.js +2 -2
  39. package/dist/research.js.map +1 -1
  40. package/dist/setup.d.ts.map +1 -1
  41. package/dist/setup.js +4 -4
  42. package/dist/setup.js.map +1 -1
  43. package/dist/skill.d.ts.map +1 -1
  44. package/dist/skill.js +8 -9
  45. package/dist/skill.js.map +1 -1
  46. package/dist/store.d.ts +7 -2
  47. package/dist/store.d.ts.map +1 -1
  48. package/dist/store.js +57 -6
  49. package/dist/store.js.map +1 -1
  50. package/dist/types.d.ts +24 -0
  51. package/dist/types.d.ts.map +1 -1
  52. package/dist/version.d.ts +1 -1
  53. package/dist/version.js +1 -1
  54. package/examples/sovereign-rag-demo/README.md +1 -1
  55. package/package.json +4 -3
  56. package/skills/ragmir/SKILL.md +77 -59
  57. package/skills/ragmir-audio-summary/SKILL.md +14 -14
  58. package/skills/ragmir-legal-dossier/SKILL.md +10 -10
  59. package/skills/ragmir-markdown-report/SKILL.md +8 -8
@@ -35,7 +35,7 @@ Two reference files sit next to this skill and are read while drafting:
35
35
 
36
36
  - Treat the source documents, retrieved passages, generated narration, and final audio as sensitive.
37
37
  - Do not use online TTS for confidential content unless the user explicitly allows it.
38
- - Prefer `pnpm exec ragmir audio` or `pnpm exec ragmir-tts render` for plug-and-play output.
38
+ - Prefer `pnpm exec rgr audio` or `pnpm exec rgr-tts render` for plug-and-play output.
39
39
  - Use `--engine transformers --offline` when model files are already present and remote model
40
40
  loading is not allowed.
41
41
  - Use `--engine edge` only when online TTS is acceptable and global Voice Forge quality is required.
@@ -63,21 +63,21 @@ gets dropped at the drafting step, not added because it was "also in the documen
63
63
  From the repository root, run:
64
64
 
65
65
  ```bash
66
- pnpm exec ragmir doctor
67
- pnpm exec ragmir status
68
- pnpm exec ragmir audit
69
- pnpm exec ragmir audit --unsupported
70
- pnpm exec ragmir security-audit
66
+ pnpm exec rgr doctor
67
+ pnpm exec rgr status
68
+ pnpm exec rgr audit
69
+ pnpm exec rgr audit --unsupported
70
+ pnpm exec rgr security-audit
71
71
  ```
72
72
 
73
73
  If the audit reports missing or stale files, run:
74
74
 
75
75
  ```bash
76
- pnpm exec ragmir doctor --fix
77
- pnpm exec ragmir audit --unsupported
76
+ pnpm exec rgr doctor --fix
77
+ pnpm exec rgr audit --unsupported
78
78
  ```
79
79
 
80
- `ragmir doctor --fix` rebuilds the index only when supported files are present and the privacy posture
80
+ `rgr doctor --fix` rebuilds the index only when supported files are present and the privacy posture
81
81
  has no warnings. Do not create an audio summary from stale or incomplete evidence unless the user
82
82
  explicitly accepts that limitation.
83
83
 
@@ -89,9 +89,9 @@ in step 1 — not from the subject alone.
89
89
  For a broad summary, run multiple searches:
90
90
 
91
91
  ```bash
92
- pnpm exec ragmir search "<main topic>" --top-k 8
93
- pnpm exec ragmir search "<people, dates, money, obligations, risks, or decisions>" --top-k 8
94
- pnpm exec ragmir ask "<specific synthesis question>" --top-k 8
92
+ pnpm exec rgr search "<main topic>" --top-k 8
93
+ pnpm exec rgr search "<people, dates, money, obligations, risks, or decisions>" --top-k 8
94
+ pnpm exec rgr ask "<specific synthesis question>" --top-k 8
95
95
  ```
96
96
 
97
97
  When MCP is available, prefer `ragmir_search`, `ragmir_ask`, `ragmir_audit`, and
@@ -177,7 +177,7 @@ neural voice for the Edge path. Write the narration in the same language you pas
177
177
  For global Voice Forge quality on non-confidential text, render with Edge MP3:
178
178
 
179
179
  ```bash
180
- pnpm exec ragmir audio /tmp/RAGMIR-SUMMARY-<subject-kebab>.txt \
180
+ pnpm exec rgr audio /tmp/RAGMIR-SUMMARY-<subject-kebab>.txt \
181
181
  --engine edge \
182
182
  --lang <en|es|fr> \
183
183
  --out .ragmir/audio/RAGMIR-SUMMARY-<subject-kebab>.mp3
@@ -189,7 +189,7 @@ the narration text to that service is acceptable.
189
189
  For confidential or air-gapped operation, preload the model files under `.ragmir/models/tts` and run:
190
190
 
191
191
  ```bash
192
- pnpm exec ragmir audio /tmp/RAGMIR-SUMMARY-<subject-kebab>.txt \
192
+ pnpm exec rgr audio /tmp/RAGMIR-SUMMARY-<subject-kebab>.txt \
193
193
  --engine transformers \
194
194
  --offline \
195
195
  --lang <en|es|fr> \
@@ -59,8 +59,8 @@ dossier and test them on non-sensitive samples first.
59
59
  After changing redaction rules, rebuild the index:
60
60
 
61
61
  ```bash
62
- pnpm exec ragmir ingest --rebuild
63
- pnpm exec ragmir security-audit --strict
62
+ pnpm exec rgr ingest --rebuild
63
+ pnpm exec rgr security-audit --strict
64
64
  ```
65
65
 
66
66
  ## Retrieval Workflow
@@ -68,19 +68,19 @@ pnpm exec ragmir security-audit --strict
68
68
  Start from readiness checks:
69
69
 
70
70
  ```bash
71
- pnpm exec ragmir doctor
72
- pnpm exec ragmir audit
73
- pnpm exec ragmir audit --unsupported
74
- pnpm exec ragmir security-audit --strict
71
+ pnpm exec rgr doctor
72
+ pnpm exec rgr audit
73
+ pnpm exec rgr audit --unsupported
74
+ pnpm exec rgr security-audit --strict
75
75
  ```
76
76
 
77
77
  Then run targeted retrieval passes:
78
78
 
79
79
  ```bash
80
- pnpm exec ragmir search "parties obligations dates amounts" --top-k 8
81
- pnpm exec ragmir search "termination clause liability indemnity notice" --top-k 8
82
- pnpm exec ragmir search "timeline meeting decision approval refusal" --top-k 8
83
- pnpm exec ragmir ask "Which documents support the chronology of events?" --top-k 8
80
+ pnpm exec rgr search "parties obligations dates amounts" --top-k 8
81
+ pnpm exec rgr search "termination clause liability indemnity notice" --top-k 8
82
+ pnpm exec rgr search "timeline meeting decision approval refusal" --top-k 8
83
+ pnpm exec rgr ask "Which documents support the chronology of events?" --top-k 8
84
84
  ```
85
85
 
86
86
  When MCP is available, prefer `ragmir_status`, `ragmir_search`, `ragmir_ask`, `ragmir_audit`, and
@@ -28,16 +28,16 @@ sanitized report is safe to commit or share.
28
28
  From the repository root:
29
29
 
30
30
  ```bash
31
- pnpm exec ragmir doctor
32
- pnpm exec ragmir audit
33
- pnpm exec ragmir security-audit
31
+ pnpm exec rgr doctor
32
+ pnpm exec rgr audit
33
+ pnpm exec rgr security-audit
34
34
  ```
35
35
 
36
36
  If files are missing, stale, or setup is incomplete:
37
37
 
38
38
  ```bash
39
- pnpm exec ragmir doctor --fix
40
- pnpm exec ragmir audit --unsupported
39
+ pnpm exec rgr doctor --fix
40
+ pnpm exec rgr audit --unsupported
41
41
  ```
42
42
 
43
43
  Do not write a final report from stale evidence unless the user explicitly accepts that limitation.
@@ -47,9 +47,9 @@ Do not write a final report from stale evidence unless the user explicitly accep
47
47
  For a broad report, use multiple targeted retrieval passes instead of one generic query:
48
48
 
49
49
  ```bash
50
- pnpm exec ragmir search "<main report topic>" --top-k 8
51
- pnpm exec ragmir search "<people, dates, amounts, obligations, risks, decisions>" --top-k 8
52
- pnpm exec ragmir ask "<specific synthesis question>" --top-k 8
50
+ pnpm exec rgr search "<main report topic>" --top-k 8
51
+ pnpm exec rgr search "<people, dates, amounts, obligations, risks, decisions>" --top-k 8
52
+ pnpm exec rgr ask "<specific synthesis question>" --top-k 8
53
53
  ```
54
54
 
55
55
  When MCP is available, prefer `ragmir_search`, `ragmir_ask`, `ragmir_audit`, and