@tryhamster/gerbil 1.0.0-rc.0 → 1.0.0-rc.10

package/README.md

@@ -5,15 +5,15 @@
 <h1 align="center">Gerbil</h1>
 
 <p align="center">
-  <strong>Local LLM inference for Node.js. GPU-accelerated. Zero config.</strong>
+  <strong>Local AI inference for Node.js. LLM, TTS, STT. GPU-accelerated. Zero config.</strong>
 </p>
 
 <p align="center">
   <a href="#install">Install</a> •
   <a href="#quick-start">Quick Start</a> •
-  <a href="#skills">Skills</a> •
+  <a href="#text-to-speech">TTS</a> •
+  <a href="#speech-to-text">STT</a> •
   <a href="./docs/ai-sdk.md">AI SDK</a> •
-  <a href="./docs/frameworks.md">Frameworks</a> •
   <a href="./docs/cli.md">CLI</a>
 </p>
 
@@ -45,6 +45,7 @@ const text = await gerbil("Explain recursion in one sentence");
 - **Zero Config** — `npx @tryhamster/gerbil "your prompt"` just works
 - **Local & Private** — No API keys, no data leaves your machine
 - **GPU Accelerated** — WebGPU with CPU fallback
+- **Complete Audio** — Text-to-Speech (Kokoro) & Speech-to-Text (Whisper)
 - **Framework Ready** — AI SDK v5, Next.js, Express, LangChain
 - **Skills System** — Built-in + custom skills with Zod validation
 - **Tool Calling** — Agentic capabilities with Qwen3 models
@@ -92,6 +93,55 @@ const data = await g.json("Extract: John, 32, NYC", {
 });
 ```
 
+## Text-to-Speech
+
+Generate natural speech locally using Kokoro TTS (28 voices):
+
+```typescript
+const result = await g.speak("Hello, I'm Gerbil!", { voice: "af_heart" });
+// result.audio = Float32Array, result.sampleRate = 24000
+
+// Stream long text
+for await (const chunk of g.speakStream("Long paragraph...")) {
+  // Play each chunk as it's generated
+}
+```
+
+```bash
+# CLI
+gerbil speak "Hello world" --voice bf_emma
+```
+
+📖 **[Full TTS Documentation →](./docs/tts.md)**
+
+## Speech-to-Text
+
+Transcribe audio locally using Whisper (7 models, 80+ languages):
+
+```typescript
+import { readFileSync } from "fs";
+
+const audio = new Uint8Array(readFileSync("recording.wav"));
+const result = await g.transcribe(audio);
+console.log(result.text);
+
+// With timestamps
+const result = await g.transcribe(audio, { timestamps: true });
+for (const seg of result.segments) {
+  console.log(`[${seg.start}s] ${seg.text}`);
+}
+
+// Record from microphone
+const result = await g.listen(5000); // 5 seconds
+```
+
+```bash
+# CLI
+gerbil transcribe audio.wav --timestamps
+```
+
+📖 **[Full STT Documentation →](./docs/stt.md)**
+
 ## Skills
 
 Built-in AI skills with Zod-validated inputs:
@@ -169,6 +219,8 @@ gerbil "Write a haiku"                        # Generate text
 gerbil commit                                 # Commit message from staged changes
 gerbil summarize README.md                    # Summarize file
 gerbil chat --thinking                        # Interactive chat
+gerbil speak "Hello world" --voice af_heart   # Text-to-speech
+gerbil transcribe audio.wav                   # Speech-to-text
 gerbil serve --mcp                            # MCP server for Claude/Cursor
 gerbil update                                 # Update to latest version
 ```
@@ -204,17 +256,19 @@ function Chat() {
 
 | Integration | Import | Docs |
 |-------------|--------|------|
-| **Browser** | `@tryhamster/gerbil/browser` | [📖 Browser Guide](./docs/browser.md) |
-| **AI SDK v5** | `@tryhamster/gerbil/ai` | [📖 AI SDK Guide](./docs/ai-sdk.md) |
+| **Browser** | `@tryhamster/gerbil/browser` | [📖 Browser](./docs/browser.md) |
+| **AI SDK v5** | `@tryhamster/gerbil/ai` | [📖 AI SDK](./docs/ai-sdk.md) |
 | **Next.js** | `@tryhamster/gerbil/next` | [📖 Frameworks](./docs/frameworks.md) |
 | **Express** | `@tryhamster/gerbil/express` | [📖 Frameworks](./docs/frameworks.md) |
-| **React** | `@tryhamster/gerbil/react` | [📖 Frameworks](./docs/frameworks.md) |
 | **LangChain** | `@tryhamster/gerbil/langchain` | [📖 Frameworks](./docs/frameworks.md) |
-| **MCP Server** | `npx @tryhamster/gerbil serve --mcp` | [📖 MCP Guide](./docs/mcp.md) |
-| **MCP Client** | `@tryhamster/gerbil/mcp-client` | [📖 MCP Client](./docs/mcp-client.md) |
+| **MCP Server** | `npx @tryhamster/gerbil serve --mcp` | [📖 MCP](./docs/mcp.md) |
+
+**Audio capabilities:** TTS and STT are built into the core `Gerbil` class, `@tryhamster/gerbil/browser` hooks, and `@tryhamster/gerbil/ai` provider.
 
 ## Models
 
+### Language Models
+
 | Model | Size | Best For |
 |-------|------|----------|
 | `qwen3-0.6b` | ~400MB | General use, reasoning (thinking mode) |
@@ -223,18 +277,29 @@ function Chat() {
 
 Use any HuggingFace model: `npx @tryhamster/gerbil -m hf:org/model "prompt"`
 
+### Audio Models
+
+| Model | Type | Size | Notes |
+|-------|------|------|-------|
+| `kokoro-82m` | TTS | ~330MB | 28 voices, English |
+| `whisper-tiny.en` | STT | 39MB | English, fastest |
+| `whisper-base.en` | STT | 74MB | English, balanced |
+| `whisper-small` | STT | 244MB | 80+ languages |
+
 ## Documentation
 
 | Guide | Description |
 |-------|-------------|
-| [📖 Browser](./docs/browser.md) | WebGPU inference in the browser |
-| [📖 Skills](./docs/skills.md) | Built-in skills, custom skill development, registry API |
-| [📖 Tools](./docs/tools.md) | Tool calling, agentic workflows, custom tools |
+| [📖 Text-to-Speech](./docs/tts.md) | Kokoro TTS, 28 voices, streaming audio |
+| [📖 Speech-to-Text](./docs/stt.md) | Whisper STT, transcription, voice input |
+| [📖 Browser](./docs/browser.md) | WebGPU inference, React hooks |
+| [📖 Skills](./docs/skills.md) | Built-in skills, custom skill development |
+| [📖 Tools](./docs/tools.md) | Tool calling, agentic workflows |
 | [📖 REPL](./docs/repl.md) | Interactive terminal dashboard |
-| [📖 AI SDK](./docs/ai-sdk.md) | Vercel AI SDK v5 integration |
-| [📖 Frameworks](./docs/frameworks.md) | Next.js, Express, React, Fastify, Hono, tRPC, LangChain |
+| [📖 AI SDK](./docs/ai-sdk.md) | Vercel AI SDK v5 (LLM, TTS, STT) |
+| [📖 Frameworks](./docs/frameworks.md) | Next.js, Express, React, LangChain |
 | [📖 CLI](./docs/cli.md) | All CLI commands and options |
-| [📖 MCP Server](./docs/mcp.md) | MCP server setup for Claude Desktop & Cursor |
+| [📖 MCP Server](./docs/mcp.md) | MCP server for Claude Desktop & Cursor |
 | [📖 MCP Client](./docs/mcp-client.md) | Connect to external MCP servers |
 
 ## Requirements

package/dist/auto-update-S9s5-g0C.mjs

@@ -0,0 +1,3 @@
+import { c as checkForUpdate, l as compareVersions, s as CURRENT_VERSION, u as installUpdate } from "./cli.mjs";
+
+export { CURRENT_VERSION, checkForUpdate, installUpdate };