voice-bird-cli 0.3.1__py3-none-any.whl

voice_bird_cli/__init__.py

@@ -0,0 +1,4 @@
+"""Python wrapper for the Voice Bird CLI Rust binary."""
+
+__all__ = ["__version__"]
+__version__ = "0.3.1"

voice_bird_cli/__main__.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+
+def _cargo_bin() -> Path:
+    name = "voice-bird-cli.exe" if os.name == "nt" else "voice-bird-cli"
+    return Path.home() / ".cargo" / "bin" / name
+
+
+def main() -> int:
+    exe = _cargo_bin()
+    if not exe.exists():
+        try:
+            subprocess.run(
+                ["cargo", "install", "voice-bird-cli", "--locked"],
+                check=True,
+            )
+        except FileNotFoundError:
+            print(
+                "voice-bird-cli PyPI package requires Rust Cargo. "
+                "Install Rust from https://rustup.rs/ and run this command again.",
+                file=sys.stderr,
+            )
+            return 1
+        except subprocess.CalledProcessError as exc:
+            return exc.returncode
+
+    return subprocess.run([str(exe), *sys.argv[1:]]).returncode
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

voice_bird_cli-0.3.1.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: voice-bird-cli
+Version: 0.3.1
+Summary: Voice Bird CLI - local-first voice transcription TUI
+Author: Voice Bird contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/voice-bird/voice-bird-cli
+Project-URL: Repository, https://github.com/voice-bird/voice-bird-cli
+Project-URL: Issues, https://github.com/voice-bird/voice-bird-cli/issues
+Keywords: voice,transcription,whisper,cli,tui
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Voice Bird CLI
+
+Voice Bird CLI is a terminal voice transcription app. It runs **locally by default** with Whisper models, so local recordings stay on your machine. When you want hosted transcription, you can opt in per source to VoiceBird Web cloud mode.
+
+![Voice Bird CLI basic flow](docs/assets/basic-flow.svg)
+
+## Basic Flow
+
+1. Pick a microphone, system-output loopback device, or app audio source.
+2. Choose local or cloud mode for that source.
+3. Press `Enter` to start a transcription slot.
+4. Watch committed and tentative transcript text stream into the TUI.
+5. In local mode, review session files under `~/voice-bird/sessions/<timestamp>-<source>/`.
+
+Local sessions contain:
+
+| File | Content |
+| --- | --- |
+| `audio.wav` | 16 kHz mono recording |
+| `transcript.jsonl` | Append-only transcript log, useful after crashes |
+| `transcript.json` | Finalized transcript segments and metadata |
+| `transcript.txt` | Plain-text transcript |
+| `meta.json` | Device, source, model, engine, and duration |
+
+## Getting Started
+
+Install one of the CLI packages, then run:
+
+```bash
+voice-bird-cli
+```
+
+On first launch, Voice Bird picks a local Whisper model and downloads it into your OS cache directory. The default model is `distil-small.en`. Settings are stored in `~/.config/voice-bird/config.toml` on Linux/macOS and `%APPDATA%\voice-bird\config.toml` on Windows.
+
+macOS users may need to grant Screen Recording permission for system or app audio capture. Apple Silicon users can optionally build the WhisperKit sidecar for ANE-accelerated local inference:
+
+```bash
+cargo run -p xtask -- build-sidecar
+```
+
+Without the sidecar, Voice Bird falls back to `whisper-rs` with whisper.cpp.
+
+## Install
+
+Cargo installs the native Rust binary directly:
+
+```bash
+cargo install voice-bird-cli
+```
+
+PyPI installs a small wrapper that installs/runs the Cargo binary:
+
+```bash
+pipx install voice-bird-cli
+# or
+pip install voice-bird-cli
+```
+
+npm installs a small wrapper that installs/runs the Cargo binary:
+
+```bash
+npm install -g voice-bird-cli
+```
+
+From source:
+
+```bash
+git clone https://github.com/voice-bird/voice-bird-cli.git
+cd voice-bird-cli
+cargo install --path .
+```
+
+The npm and PyPI packages require Rust Cargo on the machine. Use the Cargo or source install when you want the simplest path.
+
+## Local And Cloud Modes
+
+**Free local mode** is the default. It uses local Whisper inference through `whisper-rs`, or WhisperKit on macOS when the sidecar is available. Local mode does not send audio to a server and writes session artifacts to disk. Current local models are English-focused in the app flow.
+
+**Cloud mode** streams audio to VoiceBird Web at `wss://voicebird.app/api/audio/stream`. It is opt-in, requires a Voice Bird API key, and is useful when local hardware cannot keep up or when you want cloud language support. Cloud recordings live in your VoiceBird Web account instead of the local sessions folder.
+
+Your Voice Bird API key is stored in plaintext in `config.toml`; on Unix the app sets the file to `0600` best-effort.
+
+## Usage
+
+```bash
+voice-bird-cli                         # start the TUI
+voice-bird-cli --recover <session-dir> # rebuild transcript.{json,txt} after a crash
+```
+
+## Keys
+
+| Key | Action |
+| --- | --- |
+| `↑` / `↓` | Select device or app |
+| `←` / `→` | Move between panes |
+| `Enter` | Start the selected source |
+| `Space` | Clear selected app pairing |
+| `Tab` | Move between transcript slots |
+| `r` | Refresh devices and apps |
+| `c` | Toggle cloud mode for the focused source |
+| `l` | Change language for cloud mode |
+| `m` | Change model |
+| `e` | Export the latest local transcript |
+| `p` | Change local session path |
+| `x` | Clear stopped transcript slot |
+| `q` | Quit |
+| `?` | Help |
+
+## License
+
+MIT

voice_bird_cli-0.3.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+voice_bird_cli/__init__.py,sha256=GnhPpd5iCcPsYMYfemeGjWHzpt_8HxKxWVzHZJfY5XQ,106
+voice_bird_cli/__main__.py,sha256=t6wZ_7YQhj5A29exXckw0DA7moUfzoL2Iu5kvMPUE5c,953
+voice_bird_cli-0.3.1.dist-info/licenses/LICENSE,sha256=zAzaev0b27MovZwrIKxX_aZcfQ21msdp44ziY6qrenQ,1080
+voice_bird_cli-0.3.1.dist-info/METADATA,sha256=QfSibmNTEW_j8T59z6joj5rVOQtGBBnIlTLm6XddHSE,4582
+voice_bird_cli-0.3.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+voice_bird_cli-0.3.1.dist-info/entry_points.txt,sha256=tGxMUfUEI9q2JVEqFXJTHkvL7wINtZyqaGhwmifHSmY,64
+voice_bird_cli-0.3.1.dist-info/top_level.txt,sha256=EM9HOTtPsqEQM0dGySWzTmVP8pxrauILSA41t8IZJmo,15
+voice_bird_cli-0.3.1.dist-info/RECORD,,

voice_bird_cli-0.3.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

voice_bird_cli-0.3.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+voice-bird-cli = voice_bird_cli.__main__:main

voice_bird_cli-0.3.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Voice Bird 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.

voice_bird_cli-0.3.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+voice_bird_cli