@jcode.labs/mimir 0.1.1 → 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/README.md +29 -6
- package/dist/cli.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,10 +31,22 @@ ollama pull gemma4
|
|
|
31
31
|
|
|
32
32
|
## Install From npm
|
|
33
33
|
|
|
34
|
+
The package is public. Users do not need a JCode account or npm token to install it.
|
|
35
|
+
|
|
36
|
+
With pnpm:
|
|
37
|
+
|
|
34
38
|
```bash
|
|
35
39
|
pnpm add -D @jcode.labs/mimir
|
|
36
40
|
```
|
|
37
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
|
+
|
|
38
50
|
## Install From Git
|
|
39
51
|
|
|
40
52
|
```bash
|
|
@@ -59,17 +71,28 @@ pnpm pack
|
|
|
59
71
|
Initialize the local project config:
|
|
60
72
|
|
|
61
73
|
```bash
|
|
62
|
-
pnpm kb init
|
|
74
|
+
pnpm exec kb init
|
|
63
75
|
```
|
|
64
76
|
|
|
65
77
|
Add private documents under `private/`, then run:
|
|
66
78
|
|
|
67
79
|
```bash
|
|
68
|
-
pnpm kb ingest
|
|
69
|
-
pnpm kb search "vendor invoice status"
|
|
70
|
-
pnpm kb ask "What do the documents prove?"
|
|
71
|
-
pnpm kb audit
|
|
72
|
-
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
|
|
73
96
|
```
|
|
74
97
|
|
|
75
98
|
## Data Boundary
|
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.")
|