Metadata-Version: 2.4
Name: voice-tunnel
Version: 0.2.6
Summary: A local voice tunnel: talk to your coding agent from a phone browser, no app
Author: JuanjoFuchs
License-Expression: MIT
Project-URL: Homepage, https://github.com/JuanjoFuchs/voice-tunnel
Project-URL: Repository, https://github.com/JuanjoFuchs/voice-tunnel.git
Project-URL: Issues, https://github.com/JuanjoFuchs/voice-tunnel/issues
Project-URL: Documentation, https://github.com/JuanjoFuchs/voice-tunnel#readme
Keywords: voice,speech,asr,tts,cli,coding-agents,agents,tunnel
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.9
Requires-Dist: numpy>=1.24
Requires-Dist: faster-whisper>=1.0
Provides-Extra: piper
Requires-Dist: piper-tts>=1.6; extra == "piper"
Provides-Extra: parakeet
Requires-Dist: sherpa-onnx>=1.10; extra == "parakeet"
Provides-Extra: turn
Requires-Dist: onnxruntime>=1.17; extra == "turn"
Requires-Dist: transformers>=4.40; extra == "turn"
Provides-Extra: all
Requires-Dist: piper-tts>=1.6; extra == "all"
Requires-Dist: sherpa-onnx>=1.10; extra == "all"
Requires-Dist: onnxruntime>=1.17; extra == "all"
Requires-Dist: transformers>=4.40; extra == "all"
Provides-Extra: dev
Requires-Dist: build>=1.0.0; extra == "dev"
Requires-Dist: playwright>=1.40; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pyyaml>=6.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: twine>=4.0.0; extra == "dev"
Dynamic: license-file

# voice-tunnel

[![CI](https://img.shields.io/github/actions/workflow/status/JuanjoFuchs/voice-tunnel/ci.yml?branch=main&label=CI)](https://github.com/JuanjoFuchs/voice-tunnel/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/actions/workflow/status/JuanjoFuchs/voice-tunnel/release.yml?label=Release)](https://github.com/JuanjoFuchs/voice-tunnel/actions/workflows/release.yml)
[![PyPI](https://img.shields.io/pypi/v/voice-tunnel)](https://pypi.org/project/voice-tunnel/)
[![npm](https://img.shields.io/npm/v/%40juanjofuchs%2Fvoice-tunnel)](https://www.npmjs.com/package/@juanjofuchs/voice-tunnel)
[![Python](https://img.shields.io/pypi/pyversions/voice-tunnel)](https://pypi.org/project/voice-tunnel/)
[![GitHub Release](https://img.shields.io/github/v/release/JuanjoFuchs/voice-tunnel)](https://github.com/JuanjoFuchs/voice-tunnel/releases)
[![License](https://img.shields.io/github/license/JuanjoFuchs/voice-tunnel)](LICENSE)

**Talk to your coding agent from your phone.** One command opens a page any phone browser can
load — no app, no App Store — and carries audio both ways.

## Watch it work

https://github.com/user-attachments/assets/a5be07a0-b1dc-446d-919f-c9351a583a2f

A real session, phone in hand: *"can you hear me"*, then shipping a release end to end. **The
`skipped Ns` badges are the agent thinking** — that time is real and this cut discloses it rather
than editing it out. The tunnel's own half of the round trip is about a second.

## Quick start

```bash
npm install -g @juanjofuchs/voice-tunnel
voice-tunnel setup                     # engines + models, one command
voice-tunnel serve --wake claude       # use YOUR agent's name
```

Open the printed URL on your phone, tap once, and say *"hey Claude, what's the status?"*

The npm package is a launcher, not a bundle: **it needs Python 3.10+ on PATH** and builds a
private environment inside itself, touching nothing else on your machine. If you would rather
skip that layer, `pipx install voice-tunnel` is the same tool with one fewer wrapper, and
[WinGet](#winget-windows-no-python-needed) needs nothing installed at all.

Everything runs on your machine. **No GPU. No account. No speech API.**

## Driving this from an agent

Point it at `describe` before anything else:

```bash
voice-tunnel describe     # the whole contract, as JSON
```

That one call is the entire onboarding — no MCP server, no daemon, no separate documentation to
keep in sync. It returns the loop to run, the turn schema, every command and argument, the exit
codes, and the two rules an agent gets wrong first: **`watch` blocks**, so an agent not sitting in
it has left you talking to nobody; and **one thought arrives as several turns**, so answering the
first one answers the wrong question. Every command also returns a `next` field telling the agent
what to do at the moment it applies, rather than in a document it read once.

`describe` is generated from the same source as the behaviour, so it cannot drift from the tool
the way a README can. When something is wrong, `voice-tunnel doctor` says what and hands back the
command that fixes it — read its `degraded` list even when `ok` is true, because a machine can
have a neural voice and a fast recognizer sitting on disk while this process uses neither.

The wedge is borrowed from [agent-mail][am].

[am]: https://github.com/JuanjoFuchs/agent-mail-cli

## What this is

The tool holds no model and makes no decisions. It turns your speech into lines in a log and text
into speech; the agent that started it does the thinking. That is why it works with **any** agent
— Claude Code, Codex and Grok have each driven it unchanged.

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/JuanjoFuchs/voice-tunnel/main/docs/architecture-dark.svg">
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/JuanjoFuchs/voice-tunnel/main/docs/architecture-light.svg">
  <img alt="One spoken turn. You speak into a phone browser; voice-tunnel runs a wake gate and speech recognition and writes a line to a log; your agent reads that line with watch --since, reasons, and calls say; voice-tunnel synthesizes the reply and you hear it. Everything runs on your machine." src="https://raw.githubusercontent.com/JuanjoFuchs/voice-tunnel/main/docs/architecture-light.svg">
</picture>

The cursor is what makes the split safe. `watch --since <cursor>` blocks until a turn lands and
returns everything after the cursor, so nothing you said is dropped while the agent spends thirty
seconds thinking about the last thing.

## Install

### npm

```bash
npm install -g @juanjofuchs/voice-tunnel
voice-tunnel setup
```

Needs Python 3.10+ on PATH. The postinstall builds a private virtualenv inside the package and
installs the matching PyPI release into it — your global Python environment is never modified, and
`npm uninstall` removes all of it. A failed postinstall is not fatal: it reports what is missing
and the launcher repeats the guidance when you actually run the tool.

### pipx

```bash
pipx install voice-tunnel
voice-tunnel setup
```

The canonical artifact — this is a Python package, and pipx installs it isolated without the npm
layer in between.

### pip

```bash
pip install voice-tunnel
```

### WinGet (Windows, no Python needed)

```powershell
winget install JuanjoFuchs.voice-tunnel
```

The only channel that needs nothing else installed. Windows may flag it on first run: the bundle
is unsigned, and Defender's heuristic dislikes unsigned Python bundles.

### Better voice and better recognition

`voice-tunnel setup` does all of this in one command. The pieces, if you want them individually:

```bash
pip install voice-tunnel[all]      # or [piper] / [parakeet]

voice-tunnel download asr          # Parakeet — 8x faster than whisper, more accurate
voice-tunnel download voice        # a neural voice instead of the robotic one
voice-tunnel download voiceprint   # learns your voice, so the wake phrase becomes optional
voice-tunnel download turn         # ends your turn when you SOUND finished, not on a timer
voice-tunnel download --list       # what is available, what you already have
```

Two independent things are involved and having one does not get you the other: the **extras**
supply the engines, the **downloads** supply the models. `voice-tunnel doctor` says which of them
this process is actually using, which is not always the best one present.

Models are downloaded, never bundled — a Parakeet checkpoint is 631 MB and would make the package
unusable on a slow connection.

## Use it

Start the tunnel with **your agent's own name**, and put its page somewhere your phone can reach.

```bash
voice-tunnel serve --wake claude          # or codex, grok, whatever is driving
```

Your phone needs HTTPS to reach a microphone at all — that is a browser rule, and a plain LAN
address like `http://192.168.1.20:8765` gives **no microphone**, not a broken one. The simplest
fix:

```bash
tailscale serve --bg 8765
voice-tunnel config set VOICE_TUNNEL_ALLOW_CIDRS 100.64.0.0/10
```

Then, from the agent's side, this is the whole loop:

```bash
voice-tunnel watch --session dev --since -1   # BLOCKS until you speak; returns turns + a cursor
voice-tunnel say   --session dev "All green." # speaks back
voice-tunnel watch --session dev --since 7    # always resume from the cursor you were given
```

### Saying its name

The summons is a greeting plus a name: *"hey claude"*, *"hi codex"*, *"ok grok"*. **The greeting
is always required**, which is what makes any name safe — `grok` is an English verb and `cursor`
is a word you say constantly, but nobody says "hey grok" by accident.

```bash
voice-tunnel wake --name codex     # change it, live, no restart
```

Once the voiceprint knows you, you are addressed **without saying anything**.

### Interrupting it

Start talking while it is speaking and it stops — but **only for your voice**. The voiceprint has
to agree before a reply is cut off, so the television, someone else in the room, and the agent's
own voice coming back through your speakers all leave it talking.

That last one is not a corner case. Without echo cancellation a reply leaks into the microphone on
almost any device, and "the agent interrupts itself" is the default failure. Measured here: the
owner's voice scores 0.23 against a 0.15 threshold, the agent's own voice scores **0.000**.

Needs `voice-tunnel download voiceprint` and a voice it has learned. Without one it stays quiet
rather than guessing, because a tunnel that stops whenever the room makes a noise is worse than
one you cannot interrupt.

### Knowing when you have finished

By default a turn ends after a fixed silence — 1.5 seconds. That number is a compromise: shorter
cuts you off while you are still thinking, longer makes every quick question wait for nothing.

`voice-tunnel download turn` replaces it with [Smart Turn v3.2][st] (8 MB, CPU, BSD-2-Clause),
which listens to *how* the sentence ended. A finished question closes early; a trailing "I was
thinking that maybe we could…" gets more room. It runs once at each pause, not continuously, and
if it is not installed the timer works exactly as it always has.

[st]: https://github.com/pipecat-ai/smart-turn

## Requirements

**No GPU.** Every model here is CPU inference by construction — nothing in the codebase can use a
graphics card. Measured on a 20-core desktop CPU:

| | Memory | Disk | Speech recognition |
|---|---|---|---|
| **Minimum** — system voice + `whisper base.en` | 219 MB | ~150 MB | usable |
| **Recommended** — Parakeet + neural voice + voiceprint | ~1.0 GB | 788 MB | **RTF 0.11** — 7.4 s of speech in 0.85 s |

- **Python 3.10+** for pip and npm. WinGet needs nothing.
- **A phone browser.** Android Chrome is what this is tested on. The tab must stay in the
  foreground — background recording needs a native app, which this deliberately is not.
- **HTTPS to the phone**, via Tailscale or any tunnel. See [Privacy](#privacy).
- A slower CPU raises the real-time factor but does not break anything; the recognizer runs
  faster than real time with a lot of headroom.

## Privacy

Speech recognition, synthesis, the voiceprint, and every turn of the transcript stay on your
machine. There is no account and nothing is sent to a speech API.

**The transport is your choice and they are not equivalent.** Tailscale terminates TLS on your
own device, so nobody else can decrypt the audio. An ngrok or Cloudflare tunnel terminates it at
the vendor's edge — which puts the plaintext of everything you say on a machine you do not
control. Sometimes that is the only thing that works, and it is still a trade worth making
knowingly. If you expose it publicly, put real authentication in front of it: the built-in CIDR
allowlist cannot help you there, because a tunnel forwards from localhost and every request
therefore arrives from an allowed peer.

Your files are plain files. `voice-tunnel config path` says where. The voiceprint is a
192-dimension centroid — speech cannot be reconstructed from it.

## Settings

```bash
voice-tunnel config show           # every setting, its value, and where it came from
voice-tunnel rate --speed 1.4      # talk faster — applies now and every session after
voice-tunnel verbose on            # narrate every action before doing it
voice-tunnel timing                # where the time actually went, per exchange
```

Precedence is **process env > settings file > built-in default**. `.env.example` documents every
variable.

## Development

```bash
python -m venv venv
venv/Scripts/python -m pip install -e ".[dev,all]"

venv/Scripts/python -m pytest tests/ -q     # unit tests, no mic and no model
venv/Scripts/python scripts/e2e.py          # the pipeline, through a real browser
venv/Scripts/python scripts/layout.py       # page geometry, at five viewports
venv/Scripts/python scripts/channel.py      # the orb, mute and the speaking signal
venv/Scripts/python scripts/diagram.py      # regenerate the diagram above, both themes
```

| Path | What |
|---|---|
| `voice_tunnel/` | store, asr, wake, tts, voiceprint, security, server, cli, config |
| `voice_tunnel/web/index.html` | the phone client, self-contained, no build step |
| `docs/` | the README diagram, generated by `scripts/diagram.py` |
| `specs/` | 001 the tunnel · 002 packaging · 003 npm · 004 turn detection |
| `ai-docs/reference/` | security model, turn-log contract, browser constraints |

## License

MIT.
