getinvoke 0.5.3__tar.gz

getinvoke-0.5.3/.env.example

@@ -0,0 +1,40 @@
+## Reformatter backend: "none" (fastest), "openrouter", "claude-cli", or "ollama"
+## Use "none" if you paste into Claude Code / Cursor — they'll interpret raw speech fine
+REFORMATTER_BACKEND=none
+
+## OpenRouter settings (when REFORMATTER_BACKEND=openrouter)
+OPENROUTER_API_KEY=sk-or-REPLACE-ME
+DICTATION_MODEL=anthropic/claude-sonnet-4-6
+
+## Claude CLI settings (when REFORMATTER_BACKEND=claude-cli)
+# CLAUDE_CLI_PATH=claude
+# CLAUDE_CLI_MODEL=haiku
+
+## Ollama settings (when REFORMATTER_BACKEND=ollama)
+# OLLAMA_URL=http://localhost:11434
+# OLLAMA_MODEL=llama3.2
+
+## Target mode: claude-code, cursor, windsurf, copilot, raw, commit, pr
+MODE=claude-code
+
+## Whisper settings
+WHISPER_MODEL=distil-large-v3
+# WHISPER_DEVICE=auto
+
+## Language: "en", "auto" (auto-detect), or any Whisper language code (es, fr, de, zh, ja, ko, etc.)
+# LANGUAGE=en
+
+## Hotkey (mouse5, mouse4, or keyboard combo)
+# HOTKEY=mouse5
+
+## Auto-paste: "true" = insta-dump (types at cursor), "false" = clipboard only (Ctrl+V yourself)
+# AUTO_PASTE=false
+
+## Custom vocabulary (comma-separated, boosts Whisper recognition)
+# CUSTOM_VOCAB=KeyGrip,OpenRouter,pyproject,FastAPI
+
+## History
+# HISTORY_ENABLED=true
+# HISTORY_RETENTION_DAYS=30
+
+LOG_LEVEL=INFO

getinvoke-0.5.3/.github/workflows/build-installer.yml

@@ -0,0 +1,107 @@
+name: Build Windows Installer
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: windows-latest
+    env:
+      HAS_SIGNING_CERT: ${{ secrets.CODE_SIGNING_CERT_BASE64 != '' }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          pip install -e ".[gui,dev]"
+          pip install pyinstaller
+
+      - name: Install CUDA runtime libraries
+        run: pip install nvidia-cublas-cu12 nvidia-cuda-runtime-cu12
+
+      - name: Build with PyInstaller
+        run: python -m PyInstaller installer/invoke.spec --noconfirm --clean
+
+      - name: Bundle CUDA DLLs
+        shell: powershell
+        run: |
+          $sitePackages = python -c "import site; print(site.getsitepackages()[0])"
+          $cudaDlls = Get-ChildItem -Path $sitePackages -Recurse -Include "cublas64_*.dll","cublasLt64_*.dll","cudart64_*.dll"
+          foreach ($dll in $cudaDlls) {
+            Copy-Item $dll.FullName -Destination "dist\invoke\" -Force
+            Write-Host "Bundled: $($dll.Name) ($([math]::Round($dll.Length / 1MB, 1)) MB)"
+          }
+          if ($cudaDlls.Count -eq 0) { Write-Warning "No CUDA DLLs found - GPU will require system CUDA" }
+
+      - name: Smoke test
+        run: dist\invoke\invoke-cli.exe health
+        continue-on-error: true
+
+      - name: Import code signing certificate
+        if: env.HAS_SIGNING_CERT == 'true'
+        env:
+          CODE_SIGNING_CERT: ${{ secrets.CODE_SIGNING_CERT_BASE64 }}
+        shell: powershell
+        run: |
+          $certBytes = [Convert]::FromBase64String($env:CODE_SIGNING_CERT)
+          [IO.File]::WriteAllBytes("$env:RUNNER_TEMP\cert.pfx", $certBytes)
+
+      - name: Sign executables
+        if: env.HAS_SIGNING_CERT == 'true'
+        env:
+          CODE_SIGNING_PASSWORD: ${{ secrets.CODE_SIGNING_PASSWORD }}
+        shell: cmd
+        run: |
+          signtool sign /f "%RUNNER_TEMP%\cert.pfx" /p "%CODE_SIGNING_PASSWORD%" /tr http://timestamp.sectigo.com /td sha256 /fd sha256 /d "Invoke" dist\invoke\invoke.exe
+          signtool sign /f "%RUNNER_TEMP%\cert.pfx" /p "%CODE_SIGNING_PASSWORD%" /tr http://timestamp.sectigo.com /td sha256 /fd sha256 /d "Invoke" dist\invoke\invoke-cli.exe
+
+      - name: Install Inno Setup
+        run: choco install innosetup -y --no-progress
+
+      - name: Set version from tag
+        shell: bash
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          sed -i "s/#define MyAppVersion \".*\"/#define MyAppVersion \"$VERSION\"/" installer/invoke.iss
+
+      - name: Build installer
+        run: iscc installer/invoke.iss
+
+      - name: Sign installer
+        if: env.HAS_SIGNING_CERT == 'true'
+        env:
+          CODE_SIGNING_PASSWORD: ${{ secrets.CODE_SIGNING_PASSWORD }}
+        shell: cmd
+        run: |
+          for %%f in (dist\invoke-setup-*.exe) do signtool sign /f "%RUNNER_TEMP%\cert.pfx" /p "%CODE_SIGNING_PASSWORD%" /tr http://timestamp.sectigo.com /td sha256 /fd sha256 /d "Invoke Setup" "%%f"
+
+      - name: Clean up certificate
+        if: always()
+        shell: powershell
+        run: Remove-Item "$env:RUNNER_TEMP\cert.pfx" -ErrorAction SilentlyContinue
+
+      - name: Upload installer artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: invoke-installer
+          path: dist/invoke-setup-*.exe
+
+      - name: Upload to release
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/invoke-setup-*.exe
+          generate_release_notes: true

getinvoke-0.5.3/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_call:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ruff
+      - run: ruff check src/ tests/
+      - run: ruff format --check src/ tests/
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Run tests
+        run: pytest tests/ -v --ignore=tests/test_gpu.py

getinvoke-0.5.3/.github/workflows/publish-pypi.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Trusted publishing
+      contents: read   # Checkout private repo
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build sdist + wheel
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

getinvoke-0.5.3/.gitignore

@@ -0,0 +1,24 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+
+venv/
+.venv/
+env/
+
+.env
+*.wav
+*.mp3
+
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+htmlcov/
+.coverage
+
+*.log

getinvoke-0.5.3/LICENSE

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

getinvoke-0.5.3/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: getinvoke
+Version: 0.5.3
+Summary: Voice-to-prompt for developers. Hold a button, speak, release — structured prompts on your clipboard in under a second.
+Author-email: Zach Roth <zach@scrn.co>
+License-Expression: MIT
+Project-URL: Homepage, https://getinvoke.dev
+Project-URL: Repository, https://github.com/zmroth/invoke
+Keywords: voice,dictation,whisper,coding,prompt,speech-to-text,developer-tools,claude,cursor,copilot
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: faster-whisper>=1.1.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pynput>=1.8.0
+Requires-Dist: sounddevice>=0.5.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: pyperclip>=1.9.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: gui
+Requires-Dist: pystray>=0.19.0; extra == "gui"
+Requires-Dist: Pillow>=10.0.0; extra == "gui"
+Provides-Extra: cuda
+Requires-Dist: nvidia-cublas-cu12; extra == "cuda"
+Requires-Dist: nvidia-cuda-runtime-cu12; extra == "cuda"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pyinstaller; extra == "dev"
+Dynamic: license-file
+
+# Invoke
+
+[![PyPI](https://img.shields.io/pypi/v/getinvoke)](https://pypi.org/project/getinvoke/)
+[![Python](https://img.shields.io/pypi/pyversions/getinvoke)](https://pypi.org/project/getinvoke/)
+[![License](https://img.shields.io/pypi/l/getinvoke)](https://github.com/zmroth/invoke/blob/main/LICENSE)
+
+**Voice-to-prompt for developers.**
+
+Hold a button, speak, release. Your words hit the clipboard (or auto-paste at your cursor) in under a second. GPU-accelerated local transcription via Whisper — no cloud round-trip for speech-to-text.
+
+Optionally run your transcription through an AI reformatter to clean it up into structured prompts for Claude Code, Cursor, Windsurf, Copilot, or raw text.
+
+## Install
+
+```bash
+# CLI only (headless, any platform)
+pip install getinvoke
+
+# With GUI (system tray + overlay)
+pip install getinvoke[gui]
+
+# Or use pipx for isolated install
+pipx install getinvoke
+```
+
+> **Note:** The CLI command is `dictate`, not `invoke`, to avoid conflict with the pyinvoke task runner.
+
+## Quick Start
+
+```bash
+# Check your setup (GPU, mic, settings)
+dictate health
+
+# Run the setup wizard
+dictate setup
+
+# Start dictating (headless mode)
+dictate run
+
+# Start with GUI (requires [gui] extras)
+dictate run  # auto-detects GUI availability
+```
+
+**Default workflow:** Hold **Mouse5** (forward side button) → speak → release → text on clipboard.
+
+## How It Works
+
+```
+ YOU SPEAK into your mic
+     │
+     ▼
+ ┌─────────────────────────────┐
+ │  WHISPER (runs locally)     │
+ │  Model: distil-large-v3     │
+ │  GPU (CUDA) or CPU          │
+ │  No internet. No API key.   │
+ │                              │
+ │  Output: raw transcription   │
+ │  "uh so like fix the um     │
+ │   auth middleware thing"     │
+ └──────────────┬──────────────┘
+                │
+                ▼
+ ┌─────────────────────────────┐
+ │  AI REFORMATTER (optional)  │
+ │                              │
+ │  Takes raw speech and       │
+ │  reshapes it based on the   │
+ │  selected MODE:             │
+ │                              │
+ │  Claude Code → conversational│
+ │  Cursor → @file references  │
+ │  Commit → git commit msg    │
+ │  Raw → just clean up speech │
+ │  none → SKIP (no AI call)   │
+ │                              │
+ │  Backend options:            │
+ │  • openrouter (cloud API)   │
+ │  • claude-cli (local CC)    │
+ │  • ollama (fully local)     │
+ │  • none (skip AI entirely)  │
+ └──────────────┬──────────────┘
+                │
+                ▼
+ ┌─────────────────────────────┐
+ │  CLIPBOARD + AUTO-PASTE     │
+ │  "Fix the auth middleware   │
+ │   to validate JWT tokens    │
+ │   before checking roles"    │
+ └─────────────────────────────┘
+```
+
+## Platform Support
+
+| Platform | CLI (headless) | GUI (tray + overlay) | Installer |
+|---|---|---|---|
+| Windows | `pip install getinvoke` | `pip install getinvoke[gui]` | `.exe` via GitHub Releases |
+| Linux | `pip install getinvoke` | `pip install getinvoke[gui]` | — |
+| macOS | `pip install getinvoke` | Planned | — |
+
+## Comparison
+
+| Feature | Invoke | whisper.cpp CLI | nerd-dictation | macOS Dictation |
+|---|---|---|---|---|
+| Local Whisper | Yes | Yes | Yes | No |
+| AI reformatting | Yes (4 backends) | No | No | No |
+| Code-aware modes | 7 modes | No | No | No |
+| Project context | Auto-detected | No | No | No |
+| GPU acceleration | CUDA | CUDA/Metal | No | — |
+| Cross-platform | Win/Linux/Mac | Win/Linux/Mac | Linux | Mac only |
+| pip installable | Yes | No | No | — |
+
+## Requirements
+
+- Python 3.11+
+- NVIDIA GPU recommended (CUDA) — works on CPU but slower
+- Windows, Linux, or macOS
+
+## CLI Commands
+
+| Command | Description |
+|---|---|
+| `dictate run` | Start Invoke (auto-detects GUI vs headless) |
+| `dictate run --headless` | Force headless mode |
+| `dictate run --no-beep` | Start without audio feedback |
+| `dictate health` | Check GPU, model, mic, API keys, config |
+| `dictate devices` | List audio input devices |
+| `dictate modes` | List available target modes |
+| `dictate history` | View dictation history |
+| `dictate setup` | Run setup wizard |
+| `dictate setup --cli` | Force CLI wizard (no GUI) |
+| `dictate config` | View all configuration |
+| `dictate config mode cursor` | Set a config value |
+| `dictate license status` | Check license status |
+| `dictate license activate <key>` | Activate a license |
+| `dictate install` | Create Windows Startup shortcut |
+| `dictate transcribe <file>` | One-shot WAV transcription |
+| `dictate logs` | View log file |
+
+## Configuration
+
+### Key Settings
+
+| Setting | Default | Options |
+|---|---|---|
+| `reformatter_backend` | `none` | `openrouter`, `claude-cli`, `ollama`, `none` |
+| `mode` | `claude-code` | `claude-code`, `cursor`, `windsurf`, `copilot`, `raw`, `commit`, `pr` |
+| `whisper_model` | `distil-large-v3` | Any [faster-whisper model](https://huggingface.co/Systran) |
+| `whisper_device` | `auto` | `auto`, `cuda`, `cpu` |
+| `hotkey` | `mouse5` | `mouse5`, `mouse4`, or keyboard combo |
+| `auto_paste` | `false` | `true` = insta-dump at cursor |
+| `audio_device` | system default | Device index from `dictate devices` |
+| `beep_enabled` | `true` | `true` / `false` |
+
+Set values quickly from the terminal:
+```bash
+dictate config mode cursor
+dictate config reformatter_backend claude-cli
+dictate config auto_paste true
+```
+
+### AI Reformatter Backends
+
+| Backend | Where it runs | What you need | Cost |
+|---|---|---|---|
+| `openrouter` | Cloud (OpenRouter API) | `OPENROUTER_API_KEY` | ~$0.001/dictation |
+| `claude-cli` | Local (your Claude Code) | Claude Code installed | Part of your CC plan |
+| `ollama` | Local (your machine) | Ollama, LM Studio, or any local LLM server | Free, no internet |
+| `none` | Skipped entirely | Nothing | Free — raw Whisper output only |
+
+### Target Modes
+
+| Mode | What the AI does with your speech |
+|---|---|
+| `claude-code` | Formats as a conversational prompt for Claude Code |
+| `cursor` | Adds `@file` references, structured for Cursor's chat |
+| `windsurf` | Cascade-style prompt for Windsurf |
+| `copilot` | GitHub Copilot Chat format |
+| `raw` | Cleans up filler/grammar only — no prompt structure |
+| `commit` | Turns your description into a git commit message |
+| `pr` | Turns your description into a PR title + body |
+
+### Custom Vocabulary
+
+Boost Whisper recognition for domain-specific terms:
+
+```bash
+dictate config custom_vocab "KeyGrip,OpenRouter,pyproject,FastAPI,pynput"
+```
+
+### History
+
+```bash
+dictate history            # Recent entries
+dictate history -n 20      # Last 20
+dictate history -s "fix"   # Search
+```
+
+## Audio Feedback
+
+- **Short high tick** — recording started (hotkey pressed)
+- **Rising chirp** — done, text is on clipboard / pasted
+- Disable with `dictate run --no-beep` or `dictate config beep_enabled false`
+
+## System Tray (GUI mode)
+
+When installed with `pip install getinvoke[gui]`, Invoke runs in the system tray with:
+- State indicator (idle / recording / processing / error)
+- Current AI backend + model displayed
+- Mode switcher (right-click menu)
+- License management
+- Settings editor
+- Open logs
+- Quit
+
+Use `dictate-gui` to launch without a console window.
+
+## Building the Windows Installer
+
+See the [installer README](installer/) for details on building the `.exe` installer with PyInstaller + Inno Setup.
+
+## Development
+
+```bash
+pip install -e ".[dev,gui]"
+ruff check src/ tests/
+ruff format src/ tests/
+pytest
+```
+
+## Architecture
+
+```
+src/getinvoke/
+  engine.py       # Core pipeline engine (FrontendProtocol + InvokeEngine)
+  app.py          # GUI frontend wrapper (GuiFrontend + InvokeApp)
+  terminal.py     # Rich terminal frontend (TerminalFrontend)
+  cli.py          # Click CLI commands
+  setup_cli.py    # Terminal-based setup wizard
+  clipboard.py    # Copy + auto-paste via pynput
+  config.py       # Settings from config.json / env vars / .env
+  context.py      # Project context loader (18 file types + git)
+  feedback.py     # Audio cues (beeps/chirps)
+  history.py      # SQLite dictation history
+  hotkey.py       # Global hotkey listener (mouse/keyboard)
+  license.py      # Lemon Squeezy license validation (7-day trial)
+  license_gui.py  # License activation dialog (tkinter, GUI only)
+  modes/          # 7 target mode system prompts
+  overlay.py      # Recording/processing overlay (tkinter, GUI only)
+  recorder.py     # Push-to-talk audio capture (sounddevice)
+  reformatter.py  # LLM reformatting (OpenRouter/Claude CLI/Ollama/none)
+  settings_gui.py # Settings editor (tkinter, GUI only)
+  transcriber.py  # Whisper model loading + transcription
+  tray.py         # System tray icon + menu (pystray, GUI only)
+  updater.py      # Auto-updater (GitHub releases + pip-aware)
+  window.py       # Active window/file detection
+  wizard.py       # First-run setup wizard (tkinter, GUI only)
+
+installer/
+  invoke.spec     # PyInstaller build config
+  invoke.iss      # Inno Setup installer script
+  build.ps1       # Local build script
+```
+
+## License
+
+MIT — see [THIRD-PARTY-LICENSES.txt](THIRD-PARTY-LICENSES.txt) for bundled dependency licenses.