Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
attributes:
value: |
Thanks for taking the time to suggest a feature. Ragmir focuses on
sovereign local RAG for confidential datasets and AI agents. Features
confidential local RAG for coding agents and private project files. Features
that add cloud dependencies, telemetry, or hosted services are out of
scope.
- type: textarea
Expand Down Expand Up @@ -49,7 +49,7 @@ body:
- type: checkboxes
id: sovereign
attributes:
label: Sovereignty check
label: Local-first privacy check
description: Confirm this feature is compatible with Ragmir's local-first, zero-telemetry posture.
options:
- label: This feature does not require sending documents, queries, or telemetry to a hosted service.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Node.js](https://img.shields.io/node/v/@jcode.labs/ragmir)](https://www.npmjs.com/package/@jcode.labs/ragmir)
[![MIT](https://img.shields.io/github/license/jcode-works/jcode-ragmir)](./LICENSE)

**Local RAG for your coding agents.**
**Confidential local RAG for your coding agents.**

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

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

Expand Down
2 changes: 1 addition & 1 deletion context7.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://context7.com/schema/context7.json",
"projectTitle": "Ragmir",
"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.",
"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.",
"excludeFolders": [
"node_modules",
"packages/ragmir-core/dist",
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "jcode-ragmir",
"version": "0.4.12",
"private": true,
"description": "Monorepo for Ragmir, local RAG with offline cited retrieval for coding agents and scripts, plus optional local Chat and TTS.",
"description": "Monorepo for Ragmir, confidential local RAG with offline cited retrieval for coding agents and scripts, plus optional local Chat and TTS.",
"type": "module",
"license": "MIT",
"author": "Jean-Baptiste Thery (https://github.com/jb-thery)",
Expand All @@ -18,13 +18,14 @@
"ragmir",
"rag",
"local-rag",
"sovereign-rag",
"confidential-rag",
"mcp",
"ai-agents",
"coding-agents",
"nodejs",
"typescript",
"private-ai",
"offline-first",
"cited-retrieval",
"local-first",
"knowledge-base"
],
Expand Down
9 changes: 5 additions & 4 deletions packages/ragmir-chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@

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

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

Core does not require Chat or any generative model. Use this package only when the answer itself,
not just retrieval, must stay on the workstation.
Expand Down
4 changes: 3 additions & 1 deletion packages/ragmir-chat/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
"qwen",
"local-llm",
"llama-cpp",
"private-ai",
"confidential-rag",
"coding-agents",
"cited-retrieval",
"rag"
],
"repository": {
Expand Down
4 changes: 2 additions & 2 deletions packages/ragmir-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Node.js](https://img.shields.io/node/v/@jcode.labs/ragmir)](https://www.npmjs.com/package/@jcode.labs/ragmir)
[![MIT](https://img.shields.io/npm/l/@jcode.labs/ragmir)](https://github.com/jcode-works/jcode-ragmir/blob/main/LICENSE)

**Local RAG for your coding agents.**
**Confidential local RAG for your coding agents.**

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

| Example | Demonstrates |
| --- | --- |
| [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 |
| [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 |
| [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 |
| [Document evidence benchmark](https://github.com/jcode-works/jcode-ragmir/tree/main/packages/ragmir-core/examples/document-evidence-benchmark) | Recall and exact citation evaluation |

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Document evidence benchmark

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

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

Return to the [Ragmir Core README](../../README.md) or try the
[sovereign RAG demo](../sovereign-rag-demo/README.md) for a broader CLI walkthrough.
[confidential local RAG demo](../sovereign-rag-demo/README.md) for a broader CLI walkthrough.
8 changes: 4 additions & 4 deletions packages/ragmir-core/examples/library-api-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Library API demo

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

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

## Data used by the demo

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

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sovereign RAG demo
# Confidential local RAG demo

A complete, fictional workspace for learning how agents and scripts retrieve cited local project
context with Ragmir.
Expand Down
7 changes: 4 additions & 3 deletions packages/ragmir-core/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@jcode.labs/ragmir",
"version": "0.4.12",
"description": "Local RAG for coding agents, with offline cited retrieval through CLI, MCP, and TypeScript.",
"description": "Confidential local RAG for coding agents, with offline cited retrieval through CLI, MCP, and TypeScript.",
"type": "module",
"license": "MIT",
"author": {
Expand All @@ -13,12 +13,13 @@
"ragmir",
"open-source",
"rag",
"sovereign-rag",
"confidential-rag",
"ai-agents",
"coding-agents",
"knowledge-base",
"confidential-data",
"private-ai",
"offline-first",
"cited-retrieval",
"local-first",
"mcp",
"mcp-server",
Expand Down
12 changes: 6 additions & 6 deletions packages/ragmir-landing/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Ragmir Landing

The static, telemetry-free website for [Ragmir](https://ragmir.com), local RAG that indexes selected
project files on the user's machine, keeps the corpus and generated index there, and retrieves cited
evidence offline by default. Core does not upload source documents to a hosted RAG service. Public
guides are available in the
The static, telemetry-free website for [Ragmir](https://ragmir.com), a confidential local RAG for
coding agents. It indexes selected project files on the user's machine, keeps the corpus and
generated index there, and retrieves cited evidence offline by default. Core does not upload source
documents to a hosted RAG service. Public guides are available in the
[project documentation](https://github.com/jcode-works/jcode-ragmir/wiki).

This private workspace package presents the open-source CLI, TypeScript API, MCP integration,
Expand Down Expand Up @@ -86,8 +86,8 @@ Keep secrets in the environment. Never commit them or expose them through `PUBLI

- Keep English and French messages aligned whenever visible copy changes.
- Ground product claims in the current CLI, API, package, and privacy behavior.
- Position Core as local, cited RAG for coding agents and scripts without implying that Core calls
a model.
- Position Core as confidential local RAG for coding agents and scripts without implying that Core
calls a model.
- Keep Core retrieval separate from optional Chat and TTS generation.
- Lead with model-agnostic Core and present the user's preferred agent and a fully local consumer as
equal choices.
Expand Down
24 changes: 12 additions & 12 deletions packages/ragmir-landing/messages/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
"nav_github": "GitHub",
"nav_aria_label": "Main navigation",
"language_label": "Language",
"seo_home_title": "Ragmir: local RAG for coding agents and scripts",
"seo_home_description": "Index private project files locally and retrieve cited context offline for coding agents and scripts across specs, PDFs, spreadsheets, and monorepos.",
"seo_home_keywords": "Ragmir, local RAG, coding agents, AI coding agents, cited retrieval, private specifications, monorepo documentation, PDF search, XLSX search, synced Drive files, local automation scripts, persistent Node.js RAG client, local RAG API, MCP, TypeScript",
"seo_home_title": "Ragmir: confidential local RAG for coding agents",
"seo_home_description": "Index confidential project files locally and retrieve cited context offline for coding agents and scripts across specs, PDFs, spreadsheets, and monorepos.",
"seo_home_keywords": "Ragmir, confidential local RAG, local RAG, coding agents, AI coding agents, cited retrieval, private specifications, monorepo documentation, PDF search, XLSX search, synced Drive files, local automation scripts, persistent Node.js RAG client, local RAG API, MCP, TypeScript",
"seo_author": "Jean-Baptiste Thery",
"seo_robots": "index, follow",
"seo_image_alt": "Ragmir local RAG with cited retrieval for coding agents",
"seo_image_alt": "Ragmir confidential local RAG with cited retrieval for coding agents",
"seo_og_site_name": "Ragmir",
"seo_application_name": "Ragmir",
"hero_badge": "Local index | Offline retrieval | Verifiable citations | CLI, API & MCP | Open source",
"hero_title_line_1": "Local RAG for your",
"hero_title_line_2": "coding agents.",
"hero_title_line_1": "Confidential local RAG",
"hero_title_line_2": "for your coding agents.",
"hero_description": "Turn specs, Word files, PDFs, and local exports into cited evidence indexed and retrieved locally. Core works offline by default, never uploads your corpus, and calls no model.",
"hero_primary_cta": "Install Ragmir",
"hero_secondary_cta": "See use cases",
Expand Down Expand Up @@ -88,7 +88,7 @@
"demo_visa_out_indexed": "Indexed locally: official guidance, appointments, checklist, and receipts | 67 chunks.",
"demo_visa_script_research": "exec: npx rgr research \"documented requirements deadlines missing evidence\" --compact --json",
"demo_visa_out_done": "Dated checklist saved for human review. Verify every action against current official sources.",
"privacy_eyebrow": "Sovereign and private",
"privacy_eyebrow": "Local and confidential",
"privacy_title": "Keep the corpus and index local. Control what leaves.",
"privacy_text": "Ragmir has no telemetry and never uploads your corpus to a hosted RAG. Local consumers can keep the full workflow offline; a cloud agent receives retrieved passages under that provider's data policy when you choose that workflow.",
"privacy_docs_title": "Documents on disk",
Expand Down Expand Up @@ -196,7 +196,7 @@
"use_case_visa_retrieval": "Ragmir finds matching requirements, deadlines, and missing evidence with citations.",
"use_case_visa_result": "The script updates a dated checklist for human verification before any action.",
"seo_team_title": "The team behind Ragmir",
"seo_team_description": "Meet the team building Ragmir, an open-source local RAG for coding agents and scripts grounded in cited project documents.",
"seo_team_description": "Meet the team building Ragmir, an open-source confidential local RAG for coding agents and scripts grounded in cited project documents.",
"team_eyebrow": "The team",
"team_title": "Who builds Ragmir",
"team_member_jb_title": "Jean-Baptiste Thery",
Expand All @@ -209,7 +209,7 @@
"faq_title": "Frequently asked questions",
"faq_text": "What Ragmir keeps local, which optional setup commands use the network, and how to connect it to your agents.",
"faq_what_question": "What is Ragmir?",
"faq_what_answer": "Ragmir is an open-source local RAG for agents and scripts on Node.js: a library, CLI, and local MCP server that turns the files you choose into cited, queryable context. It complements agent memory and native code search for specifications, runbooks, contracts, PDFs, and other project documents. The default path works offline with no model download.",
"faq_what_answer": "Ragmir is an open-source confidential local RAG for coding agents and scripts on Node.js: a library, CLI, and local MCP server that turns the files you choose into cited, queryable context. It complements agent memory and native code search for specifications, runbooks, contracts, PDFs, and other project documents. The default path works offline with no model download.",
"faq_private_question": "Does Ragmir send my confidential code or documents?",
"faq_private_answer": "Ragmir indexes only the local folders you choose and keeps generated state in the git-ignored .ragmir/ folder. Core retrieval has no telemetry or document upload. Explicit model setup downloads public model weights, never your documents; cloud agents can receive cited passages when you choose to use them.",
"faq_agents_question": "Which AI agents and tools does Ragmir work with?",
Expand All @@ -225,21 +225,21 @@
"faq_server_question": "Does Ragmir run as a web server or use a fixed port?",
"faq_server_answer": "No. Use the local stdio MCP server for coding agents or embed the TypeScript client in a stateful Node.js process. Ragmir opens no HTTP port; a network-facing application owns authentication, authorization, rate limits, and transport security.",
"closing_eyebrow": "Start with the core",
"closing_title": "Add local RAG to your agent. Keep your project files local.",
"closing_title": "Add confidential local RAG to your agent. Keep your project files local.",
"closing_text": "Connect cited passages to your preferred agent, or prepare a local Chat profile and keep retrieval and answer generation offline. No hosted Ragmir account is required.",
"closing_primary_cta": "Open GitHub",
"closing_secondary_cta": "Install",
"closing_open_source": "Open source",
"command_copied": "Copied to clipboard",
"copy_command": "Copy command",
"footer_marquee": "#local #cited #sovereign #mcp #opensource #offline #private #documents #agents",
"footer_marquee": "#local #cited #confidential #mcp #opensource #offline #private #documents #agents",
"footer_nav_label": "Footer",
"footer_link_npm": "npm",
"footer_link_docs": "Docs",
"footer_link_releases": "Releases",
"footer_link_changelog": "Changelog",
"footer_link_api": "API reference",
"footer_text": "Ragmir is JCode Labs' local RAG layer for agents and scripts that need offline, cited retrieval from private project documents.",
"footer_text": "Ragmir is JCode Labs' confidential local RAG layer for coding agents and scripts that need offline, cited retrieval from private project documents.",
"footer_version_label": "Current Ragmir version on npm",
"strengths_eyebrow": "Useful by design",
"strengths_title": "Built for the documents your code search does not see.",
Expand Down
Loading