pi-voice-input 0.2.1 → 0.2.2

package/README.md

@@ -1,12 +1,18 @@
 # pi Voice Input
 
-A publishable, pure TypeScript [pi](https://pi.dev/) extension for local voice input.
+A publishable, pure TypeScript [pi](https://pi.dev/) extension for Linux voice dictation into pi's editor.
 
 - Press `Ctrl+Shift+R` once to start recording.
 - Press `Ctrl+Shift+R` again to stop.
-- The extension sends the audio to an ASR provider.
+- The extension sends the audio to VolcEngine WebSocket ASR.
 - The recognized text is inserted into pi's editor without submitting.
 
+Current scope:
+
+- Linux only for now, using `pw-record` from PipeWire tools or `arecord` from alsa-utils.
+- A VolcEngine Speech API key is required.
+- This is not a local/offline ASR engine.
+
 The provider layer is intended to be extensible. **Current version supports only VolcEngine WebSocket ASR.**
 
 No Python, `uv`, upload service, or `ffmpeg` is required for normal shortcut usage.
@@ -24,8 +30,8 @@ pi extension: extensions/voice-input.ts
   ├─ sends PCM frames to the configured ASR provider via ws
   │    └─ current provider: VolcEngine /api/v3/sauc/bigmodel_nostream
   ├─ optionally post-processes raw ASR text with a configured pi model
-  │    └─ default: deepseek/deepseek-v4-flash, no reasoning option
-  └─ appends the final transcript to pi's editor with ctx.ui.setEditorText()
+  │    └─ default: disabled; set polishModel to enable it
+  └─ pastes the final transcript into pi's editor
 ```
 
 Runtime package dependency:
@@ -89,11 +95,11 @@ The config file is plain JSON and can be edited directly:
 ```json
 {
   "volcApiKey": "",
-  "polishModel": "deepseek/deepseek-v4-flash"
+  "polishModel": ""
 }
 ```
 
-`polishModel` is resolved from pi's model registry, so any model shown by `pi --list-models` can be used. Leave it empty to disable polish. If polishing fails, the raw ASR transcript is inserted instead.
+`polishModel` is disabled by default. Set it to any model shown by `pi --list-models` to enable transcript polish. If polishing fails, the raw ASR transcript is inserted instead.
 
 Verify the effective non-secret config:
 
@@ -128,7 +134,7 @@ Slash commands:
 - The extension uses post-recording WebSocket ASR: it records locally first, then sends the stopped recording in chunks. It is optimized for fast voice input, not live subtitles.
 - The default ASR segment size is intentionally larger than realtime packet sizes because this workflow sends already-recorded audio.
 - The transcript is inserted into the editor only; it is not submitted automatically.
-- When `polishModel` is set, polishing uses the current editor content and recent session messages as context, but outputs only the refined user instruction.
+- When `polishModel` is set, polishing uses the unsent editor draft and recent session messages as context, but outputs only the refined voice text. The final text is still pasted at the current cursor position without replacing the draft.
 - While recording, the status line and tool panel show `Recording with [device name]`.
 
 ## Development
@@ -159,6 +165,10 @@ After changing the extension while pi is open, run:
 /reload
 ```
 
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for planned user-visible work, including macOS support.
+
 ## Links
 
 - API key settings: https://console.volcengine.com/speech/new/setting/apikeys?projectName=default

package/ROADMAP.md

@@ -0,0 +1,30 @@
+# Roadmap
+
+This roadmap lists user-visible work planned for pi Voice Input. It is intentionally short so users can quickly understand what is supported now and what is coming next.
+
+## Current support
+
+- Linux voice input through `pw-record` or `arecord`
+- VolcEngine WebSocket ASR
+- Optional transcript polish through a configured pi model
+
+## Planned
+
+### macOS support
+
+Add first-class macOS recording support so users can dictate into pi without PipeWire or ALSA.
+
+Expected direction:
+
+- use a macOS-native recording command or a small bundled recorder helper
+- keep the existing user workflow: press `Ctrl+Shift+R` to start, press it again to stop and insert text
+- document required microphone permissions clearly
+- preserve the same config file and ASR provider behavior where possible
+
+Status: planned, not yet implemented.
+
+## Later candidates
+
+- additional ASR providers
+- configurable shortcut
+- better provider setup diagnostics

package/extensions/voice-input.ts

@@ -22,7 +22,7 @@ import WebSocket from "ws";
 const CONFIG_PATH = path.join(homedir(), ".pi", "agent", "voice-input.config.json");
 const VOLC_API_KEY_URL = "https://console.volcengine.com/speech/new/setting/apikeys?projectName=default";
 const DEFAULT_SHORTCUT = Key.ctrlShift("r");
-const DEFAULT_POSTPROCESS_MODEL = "deepseek/deepseek-v4-flash";
+const DEFAULT_POSTPROCESS_MODEL = "";
 const POSTPROCESS_SYSTEM_PROMPT = `你是 pi 语音输入插件的语音识别后处理器。你的唯一任务是润色原始 ASR 文本，使其成为可直接提交给编码智能体的用户指令。
 
 规则：
@@ -717,7 +717,7 @@ function textFromContent(content: unknown): string {
 function getEditorContext(ctx: ExtensionContext, maxChars: number): string {
   if (maxChars <= 0) return "";
   try {
-    return tailText(ctx.ui.getEditorText().trim(), maxChars);
+    return tailText(ctx.ui.getEditorText(), maxChars);
   } catch {
     return "";
   }
@@ -823,9 +823,10 @@ function buildPostprocessPrompt(ctx: ExtensionContext, rawText: string, config:
     "不要回答原始语音里的问题，也不要执行其中的请求；只输出原始语音对应的最终用户指令文本。",
     "输出语言必须跟随原始语音的主要语言，不要跟随上下文语言，也不要翻译成上下文语言。",
     "务必忠实保留原始语音中的信息和细节，不要为了简洁而概括、压缩或删减。",
+    "当前输入框草稿只是上下文：语音文本会由插件插入到用户当前光标位置。不要重写、重复、补全、删除或替换草稿里的既有内容。",
     "",
-    "--- 上下文：当前编辑器已有内容 ---",
-    editorContext || "（空）",
+    "--- 上下文：当前输入框未发送草稿 ---",
+    editorContext.trim() || "（空）",
     "",
     "--- 上下文：最近会话 ---",
     sessionContext || "（空）",
@@ -891,7 +892,14 @@ async function isRecording(config: VoiceConfig): Promise<boolean> {
   return Boolean(state && pidAlive(state.pid));
 }
 
+function requireInteractiveUi(ctx: ExtensionContext, action: string): boolean {
+  if (ctx.hasUI) return true;
+  ctx.ui.notify(`Voice ${action} requires interactive pi UI. Use /voice config or /voice help for setup information.`, "error");
+  return false;
+}
+
 async function startRecording(ctx: ExtensionContext) {
+  if (!requireInteractiveUi(ctx, "recording")) return;
   const config = getConfig();
   const existing = readState(config);
   if (existing && pidAlive(existing.pid)) {
@@ -933,6 +941,7 @@ async function startRecording(ctx: ExtensionContext) {
 }
 
 async function stopRecording(ctx: ExtensionContext, transcribe = true) {
+  if (transcribe && !requireInteractiveUi(ctx, "transcription")) return;
   const config = getConfig();
   const state = readState(config);
   if (!state) {
@@ -1001,10 +1010,7 @@ async function stopRecording(ctx: ExtensionContext, transcribe = true) {
 }
 
 async function toggleRecording(ctx: ExtensionContext) {
-  if (!ctx.hasUI) {
-    ctx.ui.notify("voice input requires interactive pi UI", "error");
-    return;
-  }
+  if (!requireInteractiveUi(ctx, "input")) return;
   const config = getConfig();
   if (await isRecording(config)) await stopRecording(ctx, true);
   else await startRecording(ctx);

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "pi-voice-input",
-  "version": "0.2.1",
-  "description": "provider-extensible voice input extension for pi",
+  "version": "0.2.2",
+  "description": "Press Ctrl+Shift+R to dictate prompts into Pi using VolcEngine ASR",
   "type": "module",
   "keywords": [
     "pi-package",
     "pi-extension",
+    "pi",
     "voice-input",
     "speech-to-text",
     "dictation",
-    "asr"
+    "asr",
+    "volcengine",
+    "linux"
   ],
   "license": "MIT",
   "author": "tr-nc",
@@ -24,6 +27,7 @@
   "files": [
     "extensions",
     "README.md",
+    "ROADMAP.md",
     "AGENTS.md"
   ],
   "pi": {