@jcode.labs/ragmir 5.0.1 → 6.0.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 +17 -11
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,15 +23,21 @@ 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
|
-
##
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
26
|
+
## Four workflow examples
|
|
27
|
+
|
|
28
|
+
1. **Build a feature with Claude Code or Codex.** Ask the agent to implement account recovery from
|
|
29
|
+
the project's specification and ADR. It searches with Ragmir, opens cited passages, checks
|
|
30
|
+
exceptions, then changes the code and tests.
|
|
31
|
+
2. **Diagnose an incident with Claude Code or Codex.** Ask the agent to investigate a checkout
|
|
32
|
+
timeout from the runbook, incident report, and retry implementation before it changes code and
|
|
33
|
+
adds a regression test.
|
|
34
|
+
3. **Plan an API migration with Claude Code or Codex.** Ask the agent to retrieve compatibility,
|
|
35
|
+
rollback, and versioning rules from the migration plan and ADR before it updates callers and
|
|
36
|
+
migration tests.
|
|
37
|
+
4. **Make a confidential architecture decision.** Ask a local or self-hosted chat whether internal
|
|
38
|
+
architecture rules call for attachments in PostgreSQL or object storage. The chat retrieves cited
|
|
39
|
+
evidence with Ragmir and sends it to a downloaded Ollama model with remote calls disabled, or to
|
|
40
|
+
a model on your own server.
|
|
35
41
|
|
|
36
42
|
The index stays on the machine running Ragmir. Retrieved text is not masked. With an entirely
|
|
37
43
|
local consumer it can stay on that machine; with your own server or private-cloud model it travels
|
|
@@ -39,7 +45,7 @@ to your infrastructure; with a cloud provider the consuming app sends it to that
|
|
|
39
45
|
Confidentiality depends on the full setup, including access controls, tools, and logs. Ragmir has
|
|
40
46
|
no telemetry or hosted storage, but local indexing does not make every connected chat private.
|
|
41
47
|
|
|
42
|
-
See the [agentic
|
|
48
|
+
See the [four agentic RAG workflows](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/agent-integration.md)
|
|
43
49
|
and [TypeScript API](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md).
|
|
44
50
|
|
|
45
51
|
<!-- ragmir-setup-prompt:start -->
|
|
@@ -83,7 +89,7 @@ Never commit private corpus files, .ragmir state, models, or secrets. Treat retr
|
|
|
83
89
|
|
|
84
90
|
[Full documentation](https://github.com/jcode-works/jcode-ragmir#readme),
|
|
85
91
|
[API reference](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md),
|
|
86
|
-
[agentic
|
|
92
|
+
[four agentic RAG workflows](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/agent-integration.md),
|
|
87
93
|
and [migration](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/migration.md).
|
|
88
94
|
|
|
89
95
|
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 = "
|
|
1
|
+
export declare const VERSION = "6.0.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "
|
|
1
|
+
export const VERSION = "6.0.0";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/package.json
CHANGED