@jcode.labs/ragmir 5.0.0 → 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 +12 -8
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,8 +12,8 @@ indexing and validated rebuilds keep the local index usable as sources change.
|
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
npm install -D @jcode.labs/ragmir
|
|
15
|
-
npx rgr setup --no-ingest --agents codex
|
|
16
|
-
npx rgr sources add "docs/**/*.md" "src/**/*.ts"
|
|
15
|
+
npx rgr setup --no-ingest --agents claude,codex
|
|
16
|
+
npx rgr sources add "docs/**/*.md" "specs/**/*.docx" "src/**/*.ts"
|
|
17
17
|
npx rgr ingest
|
|
18
18
|
npx rgr search "authentication contract" --compact
|
|
19
19
|
```
|
|
@@ -23,11 +23,15 @@ Semantic embeddings are optional: install `@huggingface/transformers`, then run
|
|
|
23
23
|
`npx rgr setup --semantic` to preload the embedding model. Scanned PDFs need a supported local OCR
|
|
24
24
|
engine; inspect `npx rgr ocr doctor`, then configure it with `npx rgr ocr setup`.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Choose your workflow
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
28
|
+
- **Develop with Claude Code or Codex.** Ask your agent to implement account recovery from the
|
|
29
|
+
project's specification and ADR. It searches with Ragmir, opens cited passages, checks exceptions,
|
|
30
|
+
then changes the code and tests. Connect it with the generated MCP helper or retrieval skill.
|
|
31
|
+
- **Use a confidential local or self-hosted chat.** Ask whether internal architecture rules call
|
|
32
|
+
for attachments in PostgreSQL or object storage. The chat retrieves cited evidence with Ragmir
|
|
33
|
+
and sends it to a downloaded model running in Ollama with remote calls disabled,
|
|
34
|
+
or to a model on your own server. It returns a sourced answer for your decision.
|
|
31
35
|
|
|
32
36
|
The index stays on the machine running Ragmir. Retrieved text is not masked. With an entirely
|
|
33
37
|
local consumer it can stay on that machine; with your own server or private-cloud model it travels
|
|
@@ -35,7 +39,7 @@ to your infrastructure; with a cloud provider the consuming app sends it to that
|
|
|
35
39
|
Confidentiality depends on the full setup, including access controls, tools, and logs. Ragmir has
|
|
36
40
|
no telemetry or hosted storage, but local indexing does not make every connected chat private.
|
|
37
41
|
|
|
38
|
-
See the [
|
|
42
|
+
See the [agentic and confidential chat workflows](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/agent-integration.md)
|
|
39
43
|
and [TypeScript API](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md).
|
|
40
44
|
|
|
41
45
|
<!-- ragmir-setup-prompt:start -->
|
|
@@ -79,7 +83,7 @@ Never commit private corpus files, .ragmir state, models, or secrets. Treat retr
|
|
|
79
83
|
|
|
80
84
|
[Full documentation](https://github.com/jcode-works/jcode-ragmir#readme),
|
|
81
85
|
[API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md),
|
|
82
|
-
[
|
|
86
|
+
[agentic and confidential chat workflows](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/agent-integration.md),
|
|
83
87
|
and [migration](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/migration.md).
|
|
84
88
|
|
|
85
89
|
Open source under AGPL-3.0-only with a separate commercial licensing option from JCode Works.
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "5.0.
|
|
1
|
+
export declare const VERSION = "5.0.1";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "5.0.
|
|
1
|
+
export const VERSION = "5.0.1";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/package.json
CHANGED