@@ -19,15 +19,17 @@ built to minimize data movement, but it is not a certified high-assurance system
1919 default.
2020- MCP is read-focused: destructive tools are not exposed over MCP, and MCP retrieval is capped by
2121 ` mcpMaxTopK ` .
22- - Optional audio summaries use ` kb audio ` / ` @jcode.labs/mimir-tts ` for local WAV rendering with
23- Transformers.js. They do not require Python, ffmpeg, Piper, XTTS, or a local TTS server.
22+ - Optional audio summaries use ` kb audio ` / ` @jcode.labs/mimir-tts ` . Edge MP3 gives the highest
23+ quality when online TTS is acceptable. Transformers.js WAV is the offline/confidential path and
24+ does not require Python, ffmpeg, Piper, XTTS, or a local TTS server.
2425- npm releases are published with provenance from the protected GitHub Actions workflow.
2526- Release artifacts include a package tarball, SHA256 checksums, SBOM, and manifest.
2627
2728## Threat Model
2829
2930Mimir protects against accidental repository leaks, accidental built-in LLM usage, accidental online
30- TTS usage for generated summaries, accidental secret indexing, and weak release traceability.
31+ TTS usage when the offline path is requested, accidental secret indexing, and weak release
32+ traceability.
3133
3234Mimir does not protect against a compromised local machine, malicious dependencies already present
3335in the runtime, a user with filesystem access to the same checkout, or forensic recovery from an
@@ -65,7 +67,8 @@ pnpm exec kb ingest
6567
6668For semantic embeddings, preload the Transformers.js-compatible embedding model files inside the
6769offline environment under the configured ` embeddingModelPath ` . For audio, preload the TTS model
68- files under ` .mimir/models/tts ` and render with ` pnpm exec kb audio <text-file> --offline ` .
70+ files under ` .mimir/models/tts ` and render with
71+ ` pnpm exec kb audio <text-file> --engine transformers --offline ` .
6972
7073## Zero Network Posture
7174
@@ -130,17 +133,20 @@ Redaction changes the indexed text, not the raw files under `private/`.
130133
131134` kb install-skill ` installs an optional ` mimir-audio-summary ` skill. It is designed for listenable
132135briefings from a local Mimir index. The default renderer is ` kb audio ` , backed by
133- ` @jcode.labs/mimir-tts ` and Transformers.js .
136+ ` @jcode.labs/mimir-tts ` .
134137
135138Confidentiality defaults:
136139
137140- narration text is written to a temp file outside the repository;
138- - generated WAV audio should be written under ` .mimir/audio/ ` ;
141+ - generated MP3 or WAV audio should be written under ` .mimir/audio/ ` ;
139142- ` .mimir/ ` is ignored by Git;
140- - Python, ffmpeg, Piper, XTTS, and local TTS servers are not required for the default path;
141- - the first online-enabled render may download public model weights into ` .mimir/models/tts ` , but
142- the narration text is processed locally;
143- - ` --offline ` disables remote model loading and requires preloaded model files.
143+ - Edge MP3 uses the online Edge TTS service through the external ` edge-tts ` CLI and should be used
144+ only when sending the narration text to that service is acceptable;
145+ - Transformers.js WAV does not require Python, ffmpeg, Piper, XTTS, or a local TTS server;
146+ - the first online-enabled Transformers render may download public model weights into
147+ ` .mimir/models/tts ` , but the narration text is processed locally;
148+ - ` --engine transformers --offline ` disables remote model loading and requires preloaded model
149+ files.
144150
145151Generated audio can still contain sensitive information. Treat it like a derived confidential
146152document.
0 commit comments