@jcode.labs/ragmir 4.2.2 → 5.0.1
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/README.md +71 -160
- package/dist/chunking.d.ts +1 -1
- package/dist/chunking.d.ts.map +1 -1
- package/dist/chunking.js +17 -1
- package/dist/chunking.js.map +1 -1
- package/dist/cli-entry.js +1 -1
- package/dist/cli-entry.js.map +1 -1
- package/dist/cli-fast.d.ts +1 -3
- package/dist/cli-fast.d.ts.map +1 -1
- package/dist/cli-fast.js +2 -104
- package/dist/cli-fast.js.map +1 -1
- package/dist/cli-options.d.ts +0 -37
- package/dist/cli-options.d.ts.map +1 -1
- package/dist/cli-options.js +0 -53
- package/dist/cli-options.js.map +1 -1
- package/dist/cli.js +9 -701
- package/dist/cli.js.map +1 -1
- package/dist/client.d.ts +1 -3
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +7 -36
- package/dist/client.js.map +1 -1
- package/dist/config-migration.d.ts +6 -0
- package/dist/config-migration.d.ts.map +1 -0
- package/dist/config-migration.js +31 -0
- package/dist/config-migration.js.map +1 -0
- package/dist/config.d.ts +2 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +17 -65
- package/dist/config.js.map +1 -1
- package/dist/context-resources.d.ts.map +1 -1
- package/dist/context-resources.js +2 -14
- package/dist/context-resources.js.map +1 -1
- package/dist/defaults.d.ts +0 -3
- package/dist/defaults.d.ts.map +1 -1
- package/dist/defaults.js +0 -13
- package/dist/defaults.js.map +1 -1
- package/dist/destroy.d.ts.map +1 -1
- package/dist/destroy.js +0 -2
- package/dist/destroy.js.map +1 -1
- package/dist/doctor.d.ts.map +1 -1
- package/dist/doctor.js +1 -9
- package/dist/doctor.js.map +1 -1
- package/dist/document-structure.js.map +1 -1
- package/dist/embeddings.d.ts.map +1 -1
- package/dist/embeddings.js +9 -1
- package/dist/embeddings.js.map +1 -1
- package/dist/errors.d.ts +1 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js.map +1 -1
- package/dist/evaluate.d.ts.map +1 -1
- package/dist/evaluate.js +0 -7
- package/dist/evaluate.js.map +1 -1
- package/dist/files.js.map +1 -1
- package/dist/generation-retention.js.map +1 -1
- package/dist/gitignore.js.map +1 -1
- package/dist/index-diagnostics.js +1 -1
- package/dist/index-diagnostics.js.map +1 -1
- package/dist/index-policy.d.ts.map +1 -1
- package/dist/index-policy.js +3 -4
- package/dist/index-policy.js.map +1 -1
- package/dist/index-write-lock.js.map +1 -1
- package/dist/index.d.ts +4 -15
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -8
- package/dist/index.js.map +1 -1
- package/dist/ingest.d.ts.map +1 -1
- package/dist/ingest.js +3 -18
- package/dist/ingest.js.map +1 -1
- package/dist/ingestion-metrics.d.ts +1 -1
- package/dist/ingestion-metrics.d.ts.map +1 -1
- package/dist/ingestion-metrics.js +0 -1
- package/dist/ingestion-metrics.js.map +1 -1
- package/dist/ingestion-state.d.ts +1 -2
- package/dist/ingestion-state.d.ts.map +1 -1
- package/dist/ingestion-state.js +0 -2
- package/dist/ingestion-state.js.map +1 -1
- package/dist/lexical-scoring.d.ts +13 -0
- package/dist/lexical-scoring.d.ts.map +1 -0
- package/dist/lexical-scoring.js +35 -0
- package/dist/lexical-scoring.js.map +1 -0
- package/dist/mcp-output.d.ts +4 -31
- package/dist/mcp-output.d.ts.map +1 -1
- package/dist/mcp-output.js +4 -123
- package/dist/mcp-output.js.map +1 -1
- package/dist/mcp-summaries.d.ts +1 -12
- package/dist/mcp-summaries.d.ts.map +1 -1
- package/dist/mcp-summaries.js +0 -112
- package/dist/mcp-summaries.js.map +1 -1
- package/dist/mcp.d.ts +1 -5
- package/dist/mcp.d.ts.map +1 -1
- package/dist/mcp.js +22 -329
- package/dist/mcp.js.map +1 -1
- package/dist/ocr.d.ts +0 -1
- package/dist/ocr.d.ts.map +1 -1
- package/dist/ocr.js +0 -4
- package/dist/ocr.js.map +1 -1
- package/dist/parsing.js +13 -0
- package/dist/parsing.js.map +1 -1
- package/dist/preview.d.ts.map +1 -1
- package/dist/preview.js +2 -5
- package/dist/preview.js.map +1 -1
- package/dist/query-sanitizer.d.ts +2 -1
- package/dist/query-sanitizer.d.ts.map +1 -1
- package/dist/query-sanitizer.js +9 -127
- package/dist/query-sanitizer.js.map +1 -1
- package/dist/query.d.ts +1 -3
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +95 -71
- package/dist/query.js.map +1 -1
- package/dist/ranking.d.ts +1 -1
- package/dist/ranking.d.ts.map +1 -1
- package/dist/ranking.js +52 -41
- package/dist/ranking.js.map +1 -1
- package/dist/runtime-info.js.map +1 -1
- package/dist/search-output.d.ts +3 -0
- package/dist/search-output.d.ts.map +1 -0
- package/dist/search-output.js +26 -0
- package/dist/search-output.js.map +1 -0
- package/dist/security.d.ts.map +1 -1
- package/dist/security.js +5 -37
- package/dist/security.js.map +1 -1
- package/dist/setup-prompt.d.ts +1 -1
- package/dist/setup-prompt.d.ts.map +1 -1
- package/dist/setup-prompt.js +22 -25
- package/dist/setup-prompt.js.map +1 -1
- package/dist/setup.js +1 -1
- package/dist/setup.js.map +1 -1
- package/dist/skill.d.ts +1 -4
- package/dist/skill.d.ts.map +1 -1
- package/dist/skill.js +3 -71
- package/dist/skill.js.map +1 -1
- package/dist/storage-maintenance.js.map +1 -1
- package/dist/store.js +9 -1
- package/dist/store.js.map +1 -1
- package/dist/types.d.ts +19 -156
- package/dist/types.d.ts.map +1 -1
- package/dist/upgrade.d.ts +3 -2
- package/dist/upgrade.d.ts.map +1 -1
- package/dist/upgrade.js +20 -2
- package/dist/upgrade.js.map +1 -1
- package/dist/vector-index.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/workload.js.map +1 -1
- package/examples/document-evidence-benchmark/.ragmir/config.json +0 -9
- package/examples/document-evidence-benchmark/README.md +5 -3
- package/examples/document-evidence-benchmark/raw/rfp/security-questionnaire.md +1 -1
- package/examples/library-api-demo/README.md +17 -8
- package/examples/library-api-demo/run.mjs +6 -6
- package/examples/sovereign-rag-demo/.ragmir/config.json +3 -10
- package/examples/sovereign-rag-demo/README.md +21 -12
- package/package.json +21 -30
- package/skills/ragmir/SKILL.md +67 -199
- package/dist/access-log.d.ts +0 -30
- package/dist/access-log.d.ts.map +0 -1
- package/dist/access-log.js +0 -415
- package/dist/access-log.js.map +0 -1
- package/dist/cli-stdin.d.ts +0 -3
- package/dist/cli-stdin.d.ts.map +0 -1
- package/dist/cli-stdin.js +0 -15
- package/dist/cli-stdin.js.map +0 -1
- package/dist/portable-entry.d.ts +0 -5
- package/dist/portable-entry.d.ts.map +0 -1
- package/dist/portable-entry.js +0 -337
- package/dist/portable-entry.js.map +0 -1
- package/dist/portable.d.ts +0 -89
- package/dist/portable.d.ts.map +0 -1
- package/dist/portable.js +0 -1290
- package/dist/portable.js.map +0 -1
- package/dist/prompt-routing.d.ts +0 -12
- package/dist/prompt-routing.d.ts.map +0 -1
- package/dist/prompt-routing.js +0 -150
- package/dist/prompt-routing.js.map +0 -1
- package/dist/redaction.d.ts +0 -12
- package/dist/redaction.d.ts.map +0 -1
- package/dist/redaction.js +0 -253
- package/dist/redaction.js.map +0 -1
- package/dist/research.d.ts +0 -21
- package/dist/research.d.ts.map +0 -1
- package/dist/research.js +0 -667
- package/dist/research.js.map +0 -1
- package/dist/team-diagnostics.d.ts +0 -119
- package/dist/team-diagnostics.d.ts.map +0 -1
- package/dist/team-diagnostics.js +0 -515
- package/dist/team-diagnostics.js.map +0 -1
- package/dist/team-sync.d.ts +0 -49
- package/dist/team-sync.d.ts.map +0 -1
- package/dist/team-sync.js +0 -436
- package/dist/team-sync.js.map +0 -1
- package/skills/ragmir-audio-summary/SKILL.md +0 -80
- package/skills/ragmir-audio-summary/forge-voice.sh +0 -150
- package/skills/ragmir-audio-summary/listening-style.md +0 -92
- package/skills/ragmir-audio-summary/narration-templates.md +0 -162
- package/skills/ragmir-audio-summary/split-lines.py +0 -14
- package/skills/ragmir-audio-summary/xtts-voice.py +0 -46
- package/skills/ragmir-legal-dossier/SKILL.md +0 -143
- package/skills/ragmir-markdown-report/SKILL.md +0 -110
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: ragmir-markdown-report
|
|
3
|
-
description: >-
|
|
4
|
-
Create a cited Markdown report from a Ragmir local knowledge base. Use when the user asks for a
|
|
5
|
-
report, dossier, audit memo, planning note, evidence summary, or Markdown deliverable grounded in
|
|
6
|
-
private repository documents indexed by Ragmir.
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Ragmir Markdown Report
|
|
10
|
-
|
|
11
|
-
Use this skill to write a Markdown report from local Ragmir evidence without leaking raw documents.
|
|
12
|
-
Generated reports are derived artifacts and should stay local unless the user explicitly decides a
|
|
13
|
-
sanitized report is safe to commit or share.
|
|
14
|
-
|
|
15
|
-
## Confidentiality Rules
|
|
16
|
-
|
|
17
|
-
- Treat source documents, retrieved passages, notes, drafts, and generated reports as sensitive.
|
|
18
|
-
- Prefer writing reports under `.ragmir/reports/`, which is ignored by Git when Ragmir is installed.
|
|
19
|
-
- Do not commit generated reports by default.
|
|
20
|
-
- Do not paste long raw passages into the report. Use summaries, short cited extracts when needed,
|
|
21
|
-
and source references.
|
|
22
|
-
- Separate proven facts, inference, uncertainty, and missing evidence.
|
|
23
|
-
- For legal, tax, medical, immigration, financial, or compliance reports, include a professional
|
|
24
|
-
review section instead of presenting the report as final advice.
|
|
25
|
-
|
|
26
|
-
## 1. Verify The Knowledge Base
|
|
27
|
-
|
|
28
|
-
From the repository root:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
pnpm exec rgr doctor
|
|
32
|
-
pnpm exec rgr audit
|
|
33
|
-
pnpm exec rgr security-audit
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
If files are missing, stale, or setup is incomplete:
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
pnpm exec rgr doctor --fix
|
|
40
|
-
pnpm exec rgr audit --unsupported
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Do not write a final report from stale evidence unless the user explicitly accepts that limitation.
|
|
44
|
-
|
|
45
|
-
## 2. Build An Evidence Plan
|
|
46
|
-
|
|
47
|
-
For a broad report, use multiple targeted retrieval passes instead of one generic query:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
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
|
-
```
|
|
54
|
-
|
|
55
|
-
When MCP is available, prefer `ragmir_search`, `ragmir_ask`, `ragmir_audit`, and
|
|
56
|
-
`ragmir_security_audit` over shell commands.
|
|
57
|
-
|
|
58
|
-
Keep a working note of source paths and chunk numbers for each claim you plan to include.
|
|
59
|
-
|
|
60
|
-
## 3. Write The Report
|
|
61
|
-
|
|
62
|
-
Default report structure:
|
|
63
|
-
|
|
64
|
-
```markdown
|
|
65
|
-
# <Report Title>
|
|
66
|
-
|
|
67
|
-
## Scope
|
|
68
|
-
|
|
69
|
-
## Executive Summary
|
|
70
|
-
|
|
71
|
-
## Evidence Inventory
|
|
72
|
-
|
|
73
|
-
## Findings
|
|
74
|
-
|
|
75
|
-
## Risks And Open Questions
|
|
76
|
-
|
|
77
|
-
## Recommended Next Actions
|
|
78
|
-
|
|
79
|
-
## Sources
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
Use tables only when they make comparisons easier. Keep each finding tied to one or more source
|
|
83
|
-
paths and chunk numbers when possible.
|
|
84
|
-
|
|
85
|
-
## 4. Save Locally
|
|
86
|
-
|
|
87
|
-
Create the report directory:
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
mkdir -p .ragmir/reports
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
Write the report to:
|
|
94
|
-
|
|
95
|
-
```plain text
|
|
96
|
-
.ragmir/reports/<subject-kebab>.md
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
If the user explicitly wants a tracked report, create a sanitized file outside `.ragmir/` and state
|
|
100
|
-
which private details were excluded.
|
|
101
|
-
|
|
102
|
-
## 5. Report The Result
|
|
103
|
-
|
|
104
|
-
After writing the report, tell the user:
|
|
105
|
-
|
|
106
|
-
- the report path;
|
|
107
|
-
- whether the index was ready;
|
|
108
|
-
- how many source paths were used;
|
|
109
|
-
- any unsupported, stale, or missing files that weaken the report;
|
|
110
|
-
- whether the report is safe to commit or should remain local.
|