@jcode.labs/ragmir 2.13.0 → 2.14.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/README.md +47 -23
- package/dist/index.d.ts +3 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/examples/document-evidence-benchmark/README.md +2 -1
- package/examples/library-api-demo/README.md +3 -2
- package/examples/sovereign-rag-demo/README.md +2 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -5,17 +5,18 @@
|
|
|
5
5
|
[](https://www.npmjs.com/package/@jcode.labs/ragmir)
|
|
6
6
|
[](https://github.com/jcode-works/jcode-ragmir/blob/main/LICENSE)
|
|
7
7
|
|
|
8
|
-
**
|
|
8
|
+
**Local RAG with verifiable citations for coding agents, scripts, and MCP clients.**
|
|
9
9
|
|
|
10
10
|
`@jcode.labs/ragmir` indexes the files a project selects and returns source-backed passages without
|
|
11
11
|
a hosted document store. The default `local-hash` retrieval path works offline, without an account
|
|
12
12
|
or model download.
|
|
13
13
|
|
|
14
|
-
Core is independent of the model or client that consumes those passages. Connect the
|
|
15
|
-
|
|
16
|
-
workstation.
|
|
14
|
+
Core is independent of the model or client that consumes those passages. Connect the coding agent
|
|
15
|
+
or script you already use, keep the consumer local when no retrieved passage may leave the
|
|
16
|
+
workstation, or call the typed API from Node.js.
|
|
17
17
|
|
|
18
18
|
[Project overview](https://github.com/jcode-works/jcode-ragmir#readme) ·
|
|
19
|
+
[Documentation](https://github.com/jcode-works/jcode-ragmir/wiki) ·
|
|
19
20
|
[CLI reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/cli-reference.md) ·
|
|
20
21
|
[API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md)
|
|
21
22
|
|
|
@@ -26,27 +27,62 @@ workstation.
|
|
|
26
27
|
| Search repository documents with citations | `rgr search` |
|
|
27
28
|
| Audit a local knowledge base | `rgr audit`, `rgr doctor`, and `rgr security-audit` |
|
|
28
29
|
| Add retrieval to a Node.js application | Typed `ingest`, `search`, `ask`, and `research` exports |
|
|
29
|
-
| Give an
|
|
30
|
+
| Give an agent bounded project context | Local stdio MCP server and generated helpers |
|
|
30
31
|
| Index scanned PDFs | Embedded text first, with optional page-aware local OCR |
|
|
31
32
|
|
|
32
|
-
Core retrieves evidence. It does not require a generative model
|
|
33
|
-
|
|
33
|
+
Core retrieves cited evidence. It does not require a generative model or generate answers. Add
|
|
34
|
+
[Ragmir Chat](https://www.npmjs.com/package/@jcode.labs/ragmir-chat) only when local
|
|
34
35
|
GGUF synthesis is useful, or [Ragmir TTS](https://www.npmjs.com/package/@jcode.labs/ragmir-tts)
|
|
35
36
|
when you need audio output.
|
|
36
37
|
|
|
37
|
-
##
|
|
38
|
+
## Use Ragmir with a coding agent or script
|
|
38
39
|
|
|
39
40
|
Requires Node.js 20 or later.
|
|
40
41
|
|
|
41
42
|
```bash
|
|
42
43
|
npm install --save-dev @jcode.labs/ragmir
|
|
43
|
-
npx rgr setup
|
|
44
|
+
npx rgr setup --agents codex,claude,kimi,opencode,cline
|
|
44
45
|
npx rgr sources add "README.md" "docs/**/*.md"
|
|
45
46
|
npx rgr ingest
|
|
47
|
+
npx rgr doctor
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Then ask the selected agent:
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
Use Ragmir to find the rollout decision. Cite every claim and expand the strongest citation before
|
|
54
|
+
you recommend a change.
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Setup installs project-scoped native skills and writes a local stdio MCP helper for each selected
|
|
58
|
+
client. The generated runner pins the current project, so an agent in a monorepo does not silently
|
|
59
|
+
query a sibling index. No Ragmir-specific model is required.
|
|
60
|
+
|
|
61
|
+
The same setup works with any compatible MCP client. Hermes can launch `.ragmir/run.cjs`; local
|
|
62
|
+
scripts, CI, and internal tools can call the JSON CLI or the TypeScript API without a dedicated
|
|
63
|
+
connector.
|
|
64
|
+
|
|
65
|
+
## Use Ragmir from an automation
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npx rgr search "Should this renewal require approval?" --compact --json
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Use that command from a local shell script, a Node.js worker, or a CI step after mounting the project
|
|
72
|
+
and its local `.ragmir/` state. The process returns machine-readable cited passages; the workflow
|
|
73
|
+
decides whether to continue, request human approval, or stop.
|
|
74
|
+
|
|
75
|
+
For long-running integrations, start the local stdio server with `npx rgr serve-mcp`. The MCP surface
|
|
76
|
+
is bounded and read-focused: status, source coverage, search, retrieval-only ask, research, exact
|
|
77
|
+
citation expansion, audit, evaluation, usage, and security checks. It never exposes index deletion.
|
|
78
|
+
|
|
79
|
+
## Search directly from the CLI
|
|
80
|
+
|
|
81
|
+
```bash
|
|
46
82
|
npx rgr search "Which decision changed the rollout?"
|
|
47
83
|
```
|
|
48
84
|
|
|
49
|
-
The project
|
|
85
|
+
The project owns an ignored `.ragmir/` directory containing configuration and generated local
|
|
50
86
|
state. Ingestion is incremental, and every result identifies the source path, chunk, line range, and
|
|
51
87
|
PDF page when one is available.
|
|
52
88
|
|
|
@@ -107,19 +143,6 @@ Frequently used exports:
|
|
|
107
143
|
See the [complete API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md)
|
|
108
144
|
for options and result shapes.
|
|
109
145
|
|
|
110
|
-
## Connect your preferred AI or automation
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
npx rgr setup --agents claude,codex,kimi,opencode,cline
|
|
114
|
-
npx rgr doctor
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
Ragmir links the canonical skills into each selected client's native project folder, writes a local
|
|
118
|
-
runner plus MCP helpers, and points them at the current project. MCP
|
|
119
|
-
exposes status, search, ask, research, exact citation expansion, audit, evaluation, usage, and
|
|
120
|
-
security tools. Retrieval responses have a global byte ceiling and expose metadata-only output
|
|
121
|
-
metrics. The server does not expose index deletion.
|
|
122
|
-
|
|
123
146
|
Any compatible CLI, TypeScript, or MCP client can consume the same cited results. A hosted AI
|
|
124
147
|
receives returned passages under its provider's data policy. OpenCode or another local consumer can
|
|
125
148
|
keep the handoff on the workstation. Optional Ragmir Chat adds local answer generation, but Qwen,
|
|
@@ -185,6 +208,7 @@ before indexing sensitive material.
|
|
|
185
208
|
|
|
186
209
|
## Documentation
|
|
187
210
|
|
|
211
|
+
- [Project documentation](https://github.com/jcode-works/jcode-ragmir/wiki)
|
|
188
212
|
- [CLI reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/cli-reference.md)
|
|
189
213
|
- [TypeScript API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md)
|
|
190
214
|
- [Configuration](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/configuration.md)
|
package/dist/index.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ export { loadConfig } from "./config.js";
|
|
|
3
3
|
export { getKnowledgeBaseContext, getKnowledgeBaseSourceCatalog, } from "./context-resources.js";
|
|
4
4
|
export { destroyIndex } from "./destroy.js";
|
|
5
5
|
export { doctor } from "./doctor.js";
|
|
6
|
+
export type { PullEmbeddingModelResult } from "./embeddings.js";
|
|
6
7
|
export { clearTransformersCache, pullEmbeddingModel } from "./embeddings.js";
|
|
7
8
|
export { evaluateGoldenQueries } from "./evaluate.js";
|
|
8
9
|
export { getIndexFreshnessWarning, getLexicalScanWarning, INDEX_SCHEMA_VERSION, } from "./index-diagnostics.js";
|
|
@@ -22,6 +23,7 @@ export { ask, expandCitation, search } from "./query.js";
|
|
|
22
23
|
export { redactText } from "./redaction.js";
|
|
23
24
|
export { compactResearchReport, compactSearchResults, research } from "./research.js";
|
|
24
25
|
export { securityAudit } from "./security.js";
|
|
26
|
+
export type { EnableSemanticEmbeddingsResult } from "./semantic-config.js";
|
|
25
27
|
export { enableSemanticEmbeddings } from "./semantic-config.js";
|
|
26
28
|
export type { SetupOptions, SetupResult, SetupSemanticResult } from "./setup.js";
|
|
27
29
|
export { setupProject } from "./setup.js";
|
|
@@ -29,6 +31,6 @@ export type { AgentHelperFile, AgentInstallMode, AgentInstallScope, AgentIntegra
|
|
|
29
31
|
export { bundledSkillPath, inspectAgentIntegration, installAgentSkills, installSkill, parseAgentTargets, SUPPORTED_AGENT_TARGETS, } from "./skill.js";
|
|
30
32
|
export type { AddSourceEntriesOptions, AddSourceEntriesResult, SourceEntriesResult, } from "./sources.js";
|
|
31
33
|
export { addSourceEntries, listSourceEntries } from "./sources.js";
|
|
32
|
-
export type { AccessLogAction, AccessLogUsageOptions, AccessLogUsageReport, AskResult, AuditReport, ChunkStats, CodeEvidence, CompactSearchResult, Config, DestroyIndexResult, DoctorReport, EvaluationCaseResult, EvaluationOptions, EvaluationResult, ExpandCitationOptions, ExpandedCitation, GoldenQuery, IndexManifest, IndexManifestFile, IngestionLimitsReport, IngestResult, KnowledgeBaseContextReport, KnowledgeBaseIdentity, KnowledgeBaseInfo, KnowledgeBaseInventory, KnowledgeBaseSourceCatalog, McpOutputTool, McpOutputUsageReport, ParsedPage, PreviewChunk, PreviewChunksOptions, PreviewFile, PreviewReport, PrivacyProfile, ResearchEvidence, ResearchOptions, ResearchReport, RetrievalProfile, SearchContextChunk, SearchResult, SearchScoreExplanation, SecurityAuditReport, SourceDiagnostics, SourceDuplicateCandidate, SourcePathCandidate, } from "./types.js";
|
|
34
|
+
export type { AccessLogAction, AccessLogUsageOptions, AccessLogUsageReport, AskResult, AuditReport, ChunkStats, CodeEvidence, CompactSearchResult, Config, DestroyIndexResult, DoctorReport, EvaluationCaseResult, EvaluationOptions, EvaluationResult, ExpandCitationOptions, ExpandedCitation, GoldenQuery, IndexManifest, IndexManifestFile, IngestionLimitsReport, IngestOptions, IngestResult, KnowledgeBaseContextReport, KnowledgeBaseIdentity, KnowledgeBaseInfo, KnowledgeBaseInventory, KnowledgeBaseSourceCatalog, McpOutputTool, McpOutputUsageReport, ParsedPage, PreviewChunk, PreviewChunksOptions, PreviewFile, PreviewReport, PrivacyProfile, RedactionCount, ResearchEvidence, ResearchOptions, ResearchReport, RetrievalProfile, SearchContextChunk, SearchOptions, SearchResult, SearchScoreExplanation, SecurityAuditReport, SourceDiagnostics, SourceDuplicateCandidate, SourcePathCandidate, } from "./types.js";
|
|
33
35
|
export { VERSION } from "./version.js";
|
|
34
36
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,EACL,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnC,YAAY,EACV,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,EACZ,qBAAqB,EACrB,YAAY,GACb,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACzE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjG,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,YAAY,EACV,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,WAAW,EACX,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,YAAY,CAAA;AACnB,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAClE,YAAY,EACV,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,SAAS,EACT,WAAW,EACX,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,MAAM,EACN,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,0BAA0B,EAC1B,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACX,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,YAAY,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC/D,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,EACL,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnC,YAAY,EACV,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,EACZ,qBAAqB,EACrB,YAAY,GACb,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACzE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjG,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC7C,YAAY,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,YAAY,EACV,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,WAAW,EACX,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,YAAY,CAAA;AACnB,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAClE,YAAY,EACV,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,SAAS,EACT,WAAW,EACX,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,MAAM,EACN,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,0BAA0B,EAC1B,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACX,aAAa,EACb,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,EACL,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAUnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAEzE,OAAO,EAAE,oBAAoB,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjG,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAE7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAE/D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAczC,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,YAAY,CAAA;AAMnB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAmDlE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "2.
|
|
1
|
+
export declare const VERSION = "2.14.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "2.
|
|
1
|
+
export const VERSION = "2.14.0";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Document evidence benchmark
|
|
2
2
|
|
|
3
|
-
A deterministic, public-safe benchmark for
|
|
3
|
+
A deterministic, public-safe benchmark for the retrieval and citation quality agents receive from
|
|
4
|
+
Ragmir.
|
|
4
5
|
|
|
5
6
|
Use this example when you want to prove more than "a relevant file appeared." Its six golden queries
|
|
6
7
|
check that Ragmir retrieves the expected path and the exact file, line, chunk, or PDF-page citation.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Library API demo
|
|
2
2
|
|
|
3
|
-
A runnable smoke test for the public `@jcode.labs/ragmir` TypeScript API
|
|
3
|
+
A runnable smoke test for the public `@jcode.labs/ragmir` TypeScript API behind agent and script
|
|
4
|
+
workflows.
|
|
4
5
|
|
|
5
6
|
Use this example when you are changing Ragmir Core or evaluating it as a library rather than as a
|
|
6
7
|
CLI. It imports the same package name an external consumer uses, runs the full retrieval loop, and
|
|
@@ -83,6 +84,6 @@ deterministic and public-safe. Use a separate ignored corpus for private evaluat
|
|
|
83
84
|
| --- | --- |
|
|
84
85
|
| Learn the complete CLI workflow | [Sovereign RAG demo](../sovereign-rag-demo/README.md) |
|
|
85
86
|
| Measure exact paths and citations | [Document evidence benchmark](../document-evidence-benchmark/README.md) |
|
|
86
|
-
| Explore every exported function and option | [
|
|
87
|
+
| Explore every exported function and option | [Complete TypeScript API reference](../../../../docs/api-reference.md) |
|
|
87
88
|
|
|
88
89
|
Return to the [Ragmir Core README](../../README.md) for installation, MCP, OCR, and privacy guidance.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Sovereign RAG demo
|
|
2
2
|
|
|
3
|
-
A complete, fictional workspace for learning
|
|
3
|
+
A complete, fictional workspace for learning how agents and scripts retrieve cited local project
|
|
4
|
+
context with Ragmir.
|
|
4
5
|
|
|
5
6
|
Use this example to ingest several file types, search with citations, inspect privacy posture, find an
|
|
6
7
|
unsupported file, evaluate golden queries, and prepare agent access. It runs with offline
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jcode.labs/ragmir",
|
|
3
|
-
"version": "2.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "2.14.0",
|
|
4
|
+
"description": "Local RAG with verifiable citations for coding agents, scripts, and MCP clients.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": {
|
|
@@ -69,8 +69,8 @@
|
|
|
69
69
|
"unpdf": "^1.4.0",
|
|
70
70
|
"yaml": "^2.9.0",
|
|
71
71
|
"zod": "^4.1.13",
|
|
72
|
-
"@jcode.labs/ragmir-chat": "2.
|
|
73
|
-
"@jcode.labs/ragmir-tts": "2.
|
|
72
|
+
"@jcode.labs/ragmir-chat": "2.14.0",
|
|
73
|
+
"@jcode.labs/ragmir-tts": "2.14.0"
|
|
74
74
|
},
|
|
75
75
|
"devDependencies": {
|
|
76
76
|
"@types/html-to-text": "^9.0.4",
|