@jcode.labs/mimir 0.4.3 → 0.4.4
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 +29 -3
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/examples/sovereign-rag-demo/README.md +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,20 +1,42 @@
|
|
|
1
1
|
# Mimir Core Package
|
|
2
2
|
|
|
3
|
-
`@jcode.labs/mimir` is the core
|
|
4
|
-
|
|
3
|
+
`@jcode.labs/mimir` is the core package for Mimir, an open-source sovereign local RAG toolkit for
|
|
4
|
+
confidential datasets and AI agents.
|
|
5
5
|
|
|
6
6
|
**Full documentation:** https://github.com/jcode-works/jcode-mimir#readme
|
|
7
7
|
|
|
8
8
|
This npm README is intentionally short because package READMEs are displayed separately on npm. The
|
|
9
9
|
GitHub root README is the canonical product documentation.
|
|
10
10
|
|
|
11
|
+
## What It Does
|
|
12
|
+
|
|
13
|
+
Mimir lets a Node.js repository keep a local knowledge base next to its private documents. It indexes
|
|
14
|
+
supported local files, stores the generated retrieval index in the target repository, and exposes the
|
|
15
|
+
same evidence through:
|
|
16
|
+
|
|
17
|
+
- the `kb` CLI;
|
|
18
|
+
- a TypeScript library API;
|
|
19
|
+
- a local MCP stdio server for compatible AI agents;
|
|
20
|
+
- portable agent skills copied with `kb install-skill`.
|
|
21
|
+
|
|
22
|
+
Mimir does not send documents to a hosted RAG service and does not generate final LLM answers in
|
|
23
|
+
core. It returns cited retrieval context so the agent or model you trust can write from local
|
|
24
|
+
evidence.
|
|
25
|
+
|
|
26
|
+
## Use It For
|
|
27
|
+
|
|
28
|
+
- private project, legal, operational, research, or institutional dossiers;
|
|
29
|
+
- codebase and architecture context retrieval;
|
|
30
|
+
- local-first agent workflows with bounded MCP access;
|
|
31
|
+
- cited summaries, audits, briefs, and decision support.
|
|
32
|
+
|
|
11
33
|
## Install
|
|
12
34
|
|
|
13
35
|
```bash
|
|
14
36
|
pnpm add -D @jcode.labs/mimir
|
|
15
37
|
```
|
|
16
38
|
|
|
17
|
-
## Quick
|
|
39
|
+
## Quick Start
|
|
18
40
|
|
|
19
41
|
```bash
|
|
20
42
|
pnpm exec kb init
|
|
@@ -25,6 +47,10 @@ pnpm exec kb ask "your question"
|
|
|
25
47
|
pnpm exec kb install-skill
|
|
26
48
|
```
|
|
27
49
|
|
|
50
|
+
By default, Mimir indexes documents from `private/`, stores generated state under `.kb/`, and keeps
|
|
51
|
+
agent integration files under `.mimir/`. `kb init` adds the matching Git ignore entries for local
|
|
52
|
+
generated and private data.
|
|
53
|
+
|
|
28
54
|
## Entry Points
|
|
29
55
|
|
|
30
56
|
- CLI: `kb`
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.4.
|
|
1
|
+
export declare const VERSION = "0.4.4";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "0.4.
|
|
1
|
+
export const VERSION = "0.4.4";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
|
@@ -25,7 +25,7 @@ pnpm build
|
|
|
25
25
|
Then run the CLI from this folder:
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
cd examples/sovereign-rag-demo
|
|
28
|
+
cd packages/mimir/examples/sovereign-rag-demo
|
|
29
29
|
node ../../dist/cli.js security-audit
|
|
30
30
|
node ../../dist/cli.js ingest
|
|
31
31
|
node ../../dist/cli.js search "offline retrieval approval"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jcode.labs/mimir",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.4",
|
|
4
4
|
"description": "Mimir: open-source sovereign local RAG for confidential datasets and AI agents.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"unpdf": "^1.4.0",
|
|
66
66
|
"yaml": "^2.8.1",
|
|
67
67
|
"zod": "^4.1.13",
|
|
68
|
-
"@jcode.labs/mimir-tts": "0.4.
|
|
68
|
+
"@jcode.labs/mimir-tts": "0.4.4"
|
|
69
69
|
},
|
|
70
70
|
"devDependencies": {
|
|
71
71
|
"@types/html-to-text": "^9.0.4",
|