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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
17 changes: 16 additions & 1 deletion packages/mimir-tts/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/mimir-tts/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
32 changes: 29 additions & 3 deletions packages/mimir/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion packages/mimir/dist/version.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export declare const VERSION = "0.4.3";
export declare const VERSION = "0.4.4";
//# sourceMappingURL=version.d.ts.map
2 changes: 1 addition & 1 deletion packages/mimir/dist/version.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/mimir/examples/sovereign-rag-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion packages/mimir/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/mimir/src/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const VERSION = "0.4.3"
export const VERSION = "0.4.4"
Loading