@tychenjiajun/pi-voice 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Earendil Works contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,135 @@
-# Temporary Holding Version
+# Pi Voice
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Speech-to-text for Pi — on-device model or OpenAI-compatible remote ASR.
+
+Press a keyboard shortcut, talk, and the resulting transcript will be put directly into your chat.
+
+> **Fork notice.** `@tychenjiajun/pi-voice` is a fork of [`@earendil-works/pi-voice`](https://github.com/earendil-works/pi-voice) that adds a remote ASR backend (any OpenAI-compatible `input_audio` chat-completions endpoint) with the local model kept as a fallback. It is published independently under a personal npm scope. See the [changelog](#changelog) for what changed.
+
+## Install
+
+Install the npm package:
+
+```bash
+pi install npm:@tychenjiajun/pi-voice
+```
+
+If you prefer being on the development tip, you can install from GitHub:
+
+```bash
+pi install ssh://git@github.com/tychenjiajun/pi-voice
+```
+
+## Usage
+
+The extension registers:
+
+- a configurable terminal shortcut (`Ctrl+Alt+Z` by default) to start and stop recording;
+- `/voice`, which does the same as the shortcut. While recording, `Space` also stops and transcribes, and `Escape` discards;
+- a `transcribe_file` tool that the agent can use to transcribe local audio or video files;
+- `/voice-settings` for preferred languages, model, transcription language, microphone, and shortcut settings.
+
+`/transcribe` remains available as a compatibility alias for `/voice-settings`.
+
+## Remote ASR (OpenAI-compatible endpoint)
+
+Pi Voice can send audio to a remote ASR service instead of transcribing with the local model. It speaks the OpenAI chat-completions `input_audio` dialect: the recording is uploaded as a base64 WAV data URL and the transcript is read from `choices[0].message.content`. Any endpoint that accepts that shape works.
+
+Set it up in `/voice-settings` → **Transcription backend** → **Remote ASR (OpenAI-compatible)**. You are asked for:
+
+1. **Base URL** — endpoint root, without `/chat/completions`;
+2. **Model** — the model name your endpoint expects;
+3. **API key environment variable** — the *name* of an env var. The key itself is read from that variable at runtime and never written to settings.
+
+Then export the key before starting Pi:
+
+```bash
+export OPENAI_API_KEY=sk-...
+```
+
+Behavior:
+
+- **Local model stays as fallback.** If a remote request fails (network, quota, HTTP error, or the API key is unset), the full recording is transcribed with the configured local model instead; the failure is logged to `~/.pi/agent/pi-voice.log`. Aborted/cancelled transcriptions are never retried locally.
+- **Batch-only.** Remote transcription happens when recording stops (the ASR request carries the whole clip), so there is no streaming preview.
+- **16 kHz mono WAV** is uploaded as a base64 data URL.
+- Switching back to **Local model** restores the original behavior; the local model is still required either way (it is the fallback and file transcription still needs it).
+
+Transcripts still go through the **Chinese output** script conversion preference.
+
+## Upgrading from pi-transcribe
+
+It's recommended to install Pi Voice via NPM. If you have an older install of pi-transcribe uninstall it via: 
+
+```bash
+pi remove git:github.com/earendil-works/pi-transcribe
+```
+
+If you installed it into a project with `-l`, run `pi remove -l git:github.com/earendil-works/pi-transcribe` from that project instead. Then install Pi Voice with:
+
+```bash
+pi install npm:@tychenjiajun/pi-voice
+```
+
+## File transcription and FFmpeg
+
+The agent can call `transcribe_file` for local audio or video files. Decoded audio is limited to 128 MiB (about 35 minutes). File decoding requires the `ffmpeg` executable. Install FFmpeg with your system package manager if you don't already have it installed
+
+```bash
+# macOS with Homebrew
+brew install ffmpeg
+
+# Debian or Ubuntu
+sudo apt install ffmpeg
+
+# Windows with winget
+winget install Gyan.FFmpeg
+```
+
+If FFmpeg is installed outside `PATH`, point Pi Voice at it before starting Pi:
+
+```bash
+export PI_VOICE_FFMPEG_PATH=/path/to/ffmpeg
+```
+
+The legacy `PI_TRANSCRIBE_FFMPEG_PATH` variable remains supported when `PI_VOICE_FFMPEG_PATH` is not set.
+
+When FFmpeg is unavailable, `transcribe_file` reports platform-specific guidance to the agent. The agent should ask before running a package-manager command. Model setup is still explicit: run `/voice-settings` once in the interactive TUI to choose and, after confirmation, download a local model.
+
+## Changelog
+
+### 0.2.0
+
+First release of `@tychenjiajun/pi-voice` — a fork of [`@earendil-works/pi-voice`](https://github.com/earendil-works/pi-voice) 0.1.0, published independently under the `@tychenjiajun` scope.
+
+**Added — Remote ASR backend**
+
+- Recordings can be transcribed by any OpenAI-compatible chat-completions ASR endpoint via the `input_audio` content block.
+- Configure in `/voice-settings` → **Transcription backend** → **Remote ASR (OpenAI-compatible)**: base URL, model, and the *name* of an env var holding the API key (the key itself is never stored in settings).
+- Audio is uploaded as a 16 kHz mono WAV base64 data URL. Remote transcription is batch-only (no streaming preview).
+- **Local model fallback:** if a remote request fails (network, quota, HTTP error, or the API key is unset), the full recording is transcribed with the configured local model; the failure is logged to `~/.pi/agent/pi-voice.log`. Aborted/cancelled transcriptions are never retried locally.
+
+**Changed**
+
+- Package name, repository, homepage, and bugs URLs updated to the fork (`tychenjiajun/pi-voice`).
+- Chinese script conversion for remote transcripts mirrors the local backend (applies only when the configured language is Chinese).
+
+### 0.1.0
+
+Upstream `@earendil-works/pi-voice` initial release.
+
+## Developing & Building Pi Voice
+
+To develop or run it from a checkout:
+
+```bash
+git clone git@github.com:tychenjiajun/pi-voice.git
+cd pi-voice
+npm install --ignore-scripts
+pi -e .
+```
+
+If you want to be able to re-run onboarding you can enable the debug env var when starting Pi. This enables the `/voice-onboarding` command.
+
+```bash
+PI_VOICE_DEBUG=1 pi -e /absolute/path/to/pi-voice
+```