diff --git a/package.json b/package.json index 2abdf30..ce3a8fe 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jcode-mimir", - "version": "0.4.3", + "version": "0.4.4", "private": true, "description": "Monorepo for the Mimir open-source local RAG packages.", "type": "module", diff --git a/packages/mimir-tts/README.md b/packages/mimir-tts/README.md index 2895017..96a1e9c 100644 --- a/packages/mimir-tts/README.md +++ b/packages/mimir-tts/README.md @@ -1,19 +1,34 @@ # Mimir TTS Package `@jcode.labs/mimir-tts` is the standalone text-to-speech package used by Mimir audio summaries. +It gives Mimir a plug-and-play narration renderer without making audio generation part of the core +RAG pipeline. **Full documentation:** https://github.com/jcode-works/jcode-mimir#readme This npm README is intentionally short because package READMEs are displayed separately on npm. The GitHub root README is the canonical product documentation. +## What It Does + +The package renders text files into local audio files for briefings, study notes, project summaries, +or agent-generated narration. + +It supports two explicit paths: + +- Transformers.js WAV for offline or confidential content. This is the default path. +- Edge TTS MP3 for higher-quality online narration when sending the text to Edge TTS is acceptable. + +It does not require Python, ffmpeg, Piper, XTTS, or a local model server for the default +Transformers.js path. + ## Install ```bash pnpm add -D @jcode.labs/mimir-tts ``` -## Quick Commands +## Quick Start ```bash pnpm exec mimir-tts doctor --json diff --git a/packages/mimir-tts/package.json b/packages/mimir-tts/package.json index f522070..1ab6b09 100644 --- a/packages/mimir-tts/package.json +++ b/packages/mimir-tts/package.json @@ -1,6 +1,6 @@ { "name": "@jcode.labs/mimir-tts", - "version": "0.4.3", + "version": "0.4.4", "description": "Plug-and-play Edge-quality and offline text-to-speech for Mimir audio summaries.", "type": "module", "license": "MIT", diff --git a/packages/mimir/README.md b/packages/mimir/README.md index 2829752..eabd12b 100644 --- a/packages/mimir/README.md +++ b/packages/mimir/README.md @@ -1,20 +1,42 @@ # Mimir Core Package -`@jcode.labs/mimir` is the core Mimir package: CLI, library, MCP server, bundled agent skills, and -synthetic examples for sovereign local RAG. +`@jcode.labs/mimir` is the core package for Mimir, an open-source sovereign local RAG toolkit for +confidential datasets and AI agents. **Full documentation:** https://github.com/jcode-works/jcode-mimir#readme This npm README is intentionally short because package READMEs are displayed separately on npm. The GitHub root README is the canonical product documentation. +## What It Does + +Mimir lets a Node.js repository keep a local knowledge base next to its private documents. It indexes +supported local files, stores the generated retrieval index in the target repository, and exposes the +same evidence through: + +- the `kb` CLI; +- a TypeScript library API; +- a local MCP stdio server for compatible AI agents; +- portable agent skills copied with `kb install-skill`. + +Mimir does not send documents to a hosted RAG service and does not generate final LLM answers in +core. It returns cited retrieval context so the agent or model you trust can write from local +evidence. + +## Use It For + +- private project, legal, operational, research, or institutional dossiers; +- codebase and architecture context retrieval; +- local-first agent workflows with bounded MCP access; +- cited summaries, audits, briefs, and decision support. + ## Install ```bash pnpm add -D @jcode.labs/mimir ``` -## Quick Commands +## Quick Start ```bash pnpm exec kb init @@ -25,6 +47,10 @@ pnpm exec kb ask "your question" pnpm exec kb install-skill ``` +By default, Mimir indexes documents from `private/`, stores generated state under `.kb/`, and keeps +agent integration files under `.mimir/`. `kb init` adds the matching Git ignore entries for local +generated and private data. + ## Entry Points - CLI: `kb` diff --git a/packages/mimir/dist/version.d.ts b/packages/mimir/dist/version.d.ts index fab435a..1c350bf 100644 --- a/packages/mimir/dist/version.d.ts +++ b/packages/mimir/dist/version.d.ts @@ -1,2 +1,2 @@ -export declare const VERSION = "0.4.3"; +export declare const VERSION = "0.4.4"; //# sourceMappingURL=version.d.ts.map \ No newline at end of file diff --git a/packages/mimir/dist/version.js b/packages/mimir/dist/version.js index 8480c2d..eb3e2b3 100644 --- a/packages/mimir/dist/version.js +++ b/packages/mimir/dist/version.js @@ -1,2 +1,2 @@ -export const VERSION = "0.4.3"; +export const VERSION = "0.4.4"; //# sourceMappingURL=version.js.map \ No newline at end of file diff --git a/packages/mimir/examples/sovereign-rag-demo/README.md b/packages/mimir/examples/sovereign-rag-demo/README.md index 9dc9f0c..67f4fef 100644 --- a/packages/mimir/examples/sovereign-rag-demo/README.md +++ b/packages/mimir/examples/sovereign-rag-demo/README.md @@ -25,7 +25,7 @@ pnpm build Then run the CLI from this folder: ```bash -cd examples/sovereign-rag-demo +cd packages/mimir/examples/sovereign-rag-demo node ../../dist/cli.js security-audit node ../../dist/cli.js ingest node ../../dist/cli.js search "offline retrieval approval" diff --git a/packages/mimir/package.json b/packages/mimir/package.json index 361c2db..5ee7b3d 100644 --- a/packages/mimir/package.json +++ b/packages/mimir/package.json @@ -1,6 +1,6 @@ { "name": "@jcode.labs/mimir", - "version": "0.4.3", + "version": "0.4.4", "description": "Mimir: open-source sovereign local RAG for confidential datasets and AI agents.", "type": "module", "license": "MIT", diff --git a/packages/mimir/src/version.ts b/packages/mimir/src/version.ts index e42af3e..4a6c5d5 100644 --- a/packages/mimir/src/version.ts +++ b/packages/mimir/src/version.ts @@ -1 +1 @@ -export const VERSION = "0.4.3" +export const VERSION = "0.4.4"