@jcode.labs/mimir 0.1.0 → 0.1.2
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 -0
- package/README.md +36 -7
- package/dist/cli.js +1 -1
- package/package.json +17 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jean-Baptiste Thery
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -6,9 +6,11 @@ JCode Mimir provides a TypeScript CLI and library that can be installed in any N
|
|
|
6
6
|
repository. It indexes files from the target repository, stores vectors locally with LanceDB,
|
|
7
7
|
and uses Ollama for local embeddings and answers.
|
|
8
8
|
|
|
9
|
+
Created by Jean-Baptiste Thery as part of the JCode Labs toolchain.
|
|
10
|
+
|
|
9
11
|
## Status
|
|
10
12
|
|
|
11
|
-
Early public package.
|
|
13
|
+
Early public package. Licensed under the MIT License.
|
|
12
14
|
|
|
13
15
|
## Requirements
|
|
14
16
|
|
|
@@ -29,10 +31,22 @@ ollama pull gemma4
|
|
|
29
31
|
|
|
30
32
|
## Install From npm
|
|
31
33
|
|
|
34
|
+
The package is public. Users do not need a JCode account or npm token to install it.
|
|
35
|
+
|
|
36
|
+
With pnpm:
|
|
37
|
+
|
|
32
38
|
```bash
|
|
33
39
|
pnpm add -D @jcode.labs/mimir
|
|
34
40
|
```
|
|
35
41
|
|
|
42
|
+
With npm:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm install --save-dev @jcode.labs/mimir
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Maintainer tokens are only needed to publish new versions.
|
|
49
|
+
|
|
36
50
|
## Install From Git
|
|
37
51
|
|
|
38
52
|
```bash
|
|
@@ -57,17 +71,28 @@ pnpm pack
|
|
|
57
71
|
Initialize the local project config:
|
|
58
72
|
|
|
59
73
|
```bash
|
|
60
|
-
pnpm kb init
|
|
74
|
+
pnpm exec kb init
|
|
61
75
|
```
|
|
62
76
|
|
|
63
77
|
Add private documents under `private/`, then run:
|
|
64
78
|
|
|
65
79
|
```bash
|
|
66
|
-
pnpm kb ingest
|
|
67
|
-
pnpm kb search "vendor invoice status"
|
|
68
|
-
pnpm kb ask "What do the documents prove?"
|
|
69
|
-
pnpm kb audit
|
|
70
|
-
pnpm kb status
|
|
80
|
+
pnpm exec kb ingest
|
|
81
|
+
pnpm exec kb search "vendor invoice status"
|
|
82
|
+
pnpm exec kb ask "What do the documents prove?"
|
|
83
|
+
pnpm exec kb audit
|
|
84
|
+
pnpm exec kb status
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
With npm, use `npx` after installing the package:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
npx kb init
|
|
91
|
+
npx kb ingest
|
|
92
|
+
npx kb search "vendor invoice status"
|
|
93
|
+
npx kb ask "What do the documents prove?"
|
|
94
|
+
npx kb audit
|
|
95
|
+
npx kb status
|
|
71
96
|
```
|
|
72
97
|
|
|
73
98
|
## Data Boundary
|
|
@@ -143,3 +168,7 @@ const answer = await ask("What documents support the project timeline?")
|
|
|
143
168
|
- The vector index is stored locally.
|
|
144
169
|
- Raw private documents should stay in the target repository's ignored `private/` folder.
|
|
145
170
|
- Do not put secrets or scans inside this package repository.
|
|
171
|
+
|
|
172
|
+
## License
|
|
173
|
+
|
|
174
|
+
MIT © Jean-Baptiste Thery.
|
package/dist/cli.js
CHANGED
|
@@ -10,7 +10,7 @@ const program = new Command();
|
|
|
10
10
|
program
|
|
11
11
|
.name("kb")
|
|
12
12
|
.description("Local-first RAG knowledge base for private project documents.")
|
|
13
|
-
.version("0.1.
|
|
13
|
+
.version("0.1.2");
|
|
14
14
|
program
|
|
15
15
|
.command("init")
|
|
16
16
|
.description("Create .kb config files and private/ document folder in the current repository.")
|
package/package.json
CHANGED
|
@@ -1,10 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jcode.labs/mimir",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.2",
|
|
4
|
+
"description": "JCode Mimir: local-first memory and retrieval for private project knowledge.",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"license": "
|
|
7
|
-
"author":
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"author": {
|
|
8
|
+
"name": "Jean-Baptiste Thery",
|
|
9
|
+
"url": "https://github.com/jb-thery"
|
|
10
|
+
},
|
|
11
|
+
"keywords": [
|
|
12
|
+
"jcode",
|
|
13
|
+
"mimir",
|
|
14
|
+
"rag",
|
|
15
|
+
"knowledge-base",
|
|
16
|
+
"local-first",
|
|
17
|
+
"mcp",
|
|
18
|
+
"ollama",
|
|
19
|
+
"lancedb"
|
|
20
|
+
],
|
|
8
21
|
"repository": {
|
|
9
22
|
"type": "git",
|
|
10
23
|
"url": "git+https://github.com/jcode-works/jcode-mimir.git"
|