Skip to content

Commit df79001

Browse files
authored
docs(positioning): lead with confidential local RAG (#117) (#119)
1 parent 0befe9e commit df79001

21 files changed

Lines changed: 80 additions & 72 deletions

File tree

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to suggest a feature. Ragmir focuses on
10-
sovereign local RAG for confidential datasets and AI agents. Features
10+
confidential local RAG for coding agents and private project files. Features
1111
that add cloud dependencies, telemetry, or hosted services are out of
1212
scope.
1313
- type: textarea
@@ -49,7 +49,7 @@ body:
4949
- type: checkboxes
5050
id: sovereign
5151
attributes:
52-
label: Sovereignty check
52+
label: Local-first privacy check
5353
description: Confirm this feature is compatible with Ragmir's local-first, zero-telemetry posture.
5454
options:
5555
- label: This feature does not require sending documents, queries, or telemetry to a hosted service.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Node.js](https://img.shields.io/node/v/@jcode.labs/ragmir)](https://www.npmjs.com/package/@jcode.labs/ragmir)
77
[![MIT](https://img.shields.io/github/license/jcode-works/jcode-ragmir)](./LICENSE)
88

9-
**Local RAG for your coding agents.**
9+
**Confidential local RAG for your coding agents.**
1010

1111
Ragmir indexes the project files you choose on your machine and retrieves bounded, cited evidence
1212
offline by default. The corpus and generated index remain local, so confidential source files are
@@ -242,7 +242,7 @@ Installing Core does not install Chat or TTS. Add only the optional package need
242242

243243
| Example | What it proves |
244244
| --- | --- |
245-
| [Sovereign RAG demo](./packages/ragmir-core/examples/sovereign-rag-demo/README.md) | End-to-end CLI ingestion, retrieval, redaction, audit, and evaluation |
245+
| [Confidential local RAG demo](./packages/ragmir-core/examples/sovereign-rag-demo/README.md) | End-to-end CLI ingestion, retrieval, redaction, audit, and evaluation |
246246
| [Library API demo](./packages/ragmir-core/examples/library-api-demo/README.md) | The public TypeScript API against a synthetic local corpus |
247247
| [Document evidence benchmark](./packages/ragmir-core/examples/document-evidence-benchmark/README.md) | Deterministic recall and exact file, line, chunk, and PDF-page citations |
248248

context7.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://context7.com/schema/context7.json",
33
"projectTitle": "Ragmir",
4-
"description": "Local RAG for coding agents and scripts, with offline cited retrieval. The TypeScript CLI, library, read-focused MCP server, and portable skills keep the corpus and index under ignored local state. Optional local Chat and TTS remain separate packages.",
4+
"description": "Confidential local RAG for coding agents and scripts, with offline cited retrieval. The TypeScript CLI, library, read-focused MCP server, and portable skills keep the corpus and index under ignored local state. Optional local Chat and TTS remain separate packages.",
55
"excludeFolders": [
66
"node_modules",
77
"packages/ragmir-core/dist",

package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "jcode-ragmir",
33
"version": "0.4.12",
44
"private": true,
5-
"description": "Monorepo for Ragmir, local RAG with offline cited retrieval for coding agents and scripts, plus optional local Chat and TTS.",
5+
"description": "Monorepo for Ragmir, confidential local RAG with offline cited retrieval for coding agents and scripts, plus optional local Chat and TTS.",
66
"type": "module",
77
"license": "MIT",
88
"author": "Jean-Baptiste Thery (https://github.com/jb-thery)",
@@ -18,13 +18,14 @@
1818
"ragmir",
1919
"rag",
2020
"local-rag",
21-
"sovereign-rag",
21+
"confidential-rag",
2222
"mcp",
2323
"ai-agents",
2424
"coding-agents",
2525
"nodejs",
2626
"typescript",
27-
"private-ai",
27+
"offline-first",
28+
"cited-retrieval",
2829
"local-first",
2930
"knowledge-base"
3031
],

packages/ragmir-chat/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77

88
**Optional local answers for your coding-agent RAG workflow.**
99

10-
Ragmir Core indexes selected project files on your machine and retrieves cited evidence offline by
11-
default, without uploading the source corpus to a hosted RAG service. `@jcode.labs/ragmir-chat` adds
12-
an optional answer step on the same machine: it runs a verified local model, limits generation to
13-
the retrieved passages, and validates the source markers in the visible answer.
10+
Ragmir Core is a confidential local RAG for coding agents. It indexes selected project files on your
11+
machine and retrieves cited evidence offline by default, without uploading the source corpus to a
12+
hosted RAG service. `@jcode.labs/ragmir-chat` adds an optional answer step on the same machine: it
13+
runs a verified local model, limits generation to the retrieved passages, and validates the source
14+
markers in the visible answer.
1415

1516
Core does not require Chat or any generative model. Use this package only when the answer itself,
1617
not just retrieval, must stay on the workstation.

packages/ragmir-chat/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818
"qwen",
1919
"local-llm",
2020
"llama-cpp",
21-
"private-ai",
21+
"confidential-rag",
22+
"coding-agents",
23+
"cited-retrieval",
2224
"rag"
2325
],
2426
"repository": {

packages/ragmir-core/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Node.js](https://img.shields.io/node/v/@jcode.labs/ragmir)](https://www.npmjs.com/package/@jcode.labs/ragmir)
66
[![MIT](https://img.shields.io/npm/l/@jcode.labs/ragmir)](https://github.com/jcode-works/jcode-ragmir/blob/main/LICENSE)
77

8-
**Local RAG for your coding agents.**
8+
**Confidential local RAG for your coding agents.**
99

1010
`@jcode.labs/ragmir` indexes the project files you select on your machine and retrieves bounded,
1111
cited evidence offline by default. The corpus and generated index remain local, so confidential
@@ -213,7 +213,7 @@ before indexing sensitive material.
213213

214214
| Example | Demonstrates |
215215
| --- | --- |
216-
| [Sovereign RAG demo](https://github.com/jcode-works/jcode-ragmir/tree/main/packages/ragmir-core/examples/sovereign-rag-demo) | CLI ingestion, search, audit, redaction, and evaluation |
216+
| [Confidential local RAG demo](https://github.com/jcode-works/jcode-ragmir/tree/main/packages/ragmir-core/examples/sovereign-rag-demo) | CLI ingestion, search, audit, redaction, and evaluation |
217217
| [Library API demo](https://github.com/jcode-works/jcode-ragmir/tree/main/packages/ragmir-core/examples/library-api-demo) | The public library surface against fictional files |
218218
| [Document evidence benchmark](https://github.com/jcode-works/jcode-ragmir/tree/main/packages/ragmir-core/examples/document-evidence-benchmark) | Recall and exact citation evaluation |
219219

packages/ragmir-core/examples/document-evidence-benchmark/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Document evidence benchmark
22

3-
A deterministic, public-safe benchmark for the retrieval and citation quality agents receive from
4-
Ragmir.
3+
A deterministic, public-safe benchmark for the retrieval and citation quality coding agents receive
4+
from Ragmir's confidential local RAG pipeline.
55

66
Use this example when you want to prove more than "a relevant file appeared." Its six golden queries
77
check that Ragmir retrieves the expected path and the exact file, line, chunk, or PDF-page citation.
@@ -89,4 +89,4 @@ under ignored local state.
8989
- A perfect synthetic score proves this fixture, not universal retrieval quality.
9090

9191
Return to the [Ragmir Core README](../../README.md) or try the
92-
[sovereign RAG demo](../sovereign-rag-demo/README.md) for a broader CLI walkthrough.
92+
[confidential local RAG demo](../sovereign-rag-demo/README.md) for a broader CLI walkthrough.

packages/ragmir-core/examples/library-api-demo/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Library API demo
22

3-
A runnable smoke test for the public `@jcode.labs/ragmir` TypeScript API behind agent and script
4-
workflows.
3+
A runnable smoke test for the public `@jcode.labs/ragmir` TypeScript API behind confidential local
4+
RAG workflows for coding agents and scripts.
55

66
Use this example when you are changing Ragmir Core or evaluating it as a library rather than as a
77
CLI. It imports the same package name an external consumer uses, runs the full retrieval loop, and
@@ -69,7 +69,7 @@ long-running Node.js process and close it during shutdown. For one-shot scripts,
6969

7070
## Data used by the demo
7171

72-
The script reuses the sibling [sovereign RAG demo](../sovereign-rag-demo/README.md):
72+
The script reuses the sibling [confidential local RAG demo](../sovereign-rag-demo/README.md):
7373

7474
- committed synthetic Markdown, CSV, JSONL, YAML, and custom text files;
7575
- an offline `local-hash` configuration;
@@ -83,7 +83,7 @@ deterministic and public-safe. Use a separate ignored corpus for private evaluat
8383

8484
| Need | Example |
8585
| --- | --- |
86-
| Learn the complete CLI workflow | [Sovereign RAG demo](../sovereign-rag-demo/README.md) |
86+
| Learn the complete CLI workflow | [Confidential local RAG demo](../sovereign-rag-demo/README.md) |
8787
| Measure exact paths and citations | [Document evidence benchmark](../document-evidence-benchmark/README.md) |
8888
| Explore every exported function and option | [Complete TypeScript API reference](../../../../docs/api-reference.md) |
8989

packages/ragmir-core/examples/sovereign-rag-demo/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sovereign RAG demo
1+
# Confidential local RAG demo
22

33
A complete, fictional workspace for learning how agents and scripts retrieve cited local project
44
context with Ragmir.

0 commit comments

Comments
 (0)