opencode-voice-dictation/README.md

OpenCode Voice Dictation / Голосовая диктовка для OpenCode

Voice dictation for OpenCode web interface using OpenAI Whisper via Groq API. Works on both desktop and mobile browsers through a Tampermonkey/Violentmonkey userscript.

Голосовая диктовка для веб-интерфейса OpenCode с использованием OpenAI Whisper через Groq API. Работает как на десктопных, так и на мобильных браузерах через юзерскрипт Tampermonkey/Violentmonkey.

---

English

Features

• Whisper large-v3 transcription via Groq API (same quality as Cursor)
• Tap-to-toggle recording (tap to start, tap to stop)
• Noise suppression + echo cancellation (great for outdoor use)
• Recording timer (MM:SS display)
• Ctrl+Space keyboard shortcut on desktop
• Custom Whisper prompt for software development context
• Auto-detect language (Russian + English technical terms)
• Auto-submit option (configurable)
• No backend needed — API calls go directly from browser via GM_xmlhttpRequest

Requirements

Component	Requirement
OpenCode	Web interface running (opencode web)
Groq API key	Free at console.groq.com/keys
PC Browser	Vivaldi / Chrome / Firefox + Violentmonkey or Tampermonkey
Mobile Browser	Firefox for Android + Tampermonkey

Compatibility

Platform	Browser	Userscript Manager	Status
Desktop (Linux/macOS/Windows)	Vivaldi	Violentmonkey	✅ Supported
Desktop	Chrome	Tampermonkey	✅ Supported
Desktop	Firefox	Tampermonkey	✅ Supported
Android	Firefox	Tampermonkey	✅ Supported
Android	Vivaldi	—	❌ No extension support
Android	Chrome	—	❌ No extension support

Install

Desktop (Vivaldi + Violentmonkey)

1. Install Violentmonkey extension in Vivaldi
2. Open Violentmonkey dashboard → + → Create new script
3. Paste the contents of dist/opencode-voice-dictation.user.js
4. Save (Ctrl+S)

Android (Firefox + Tampermonkey)

1. Install Firefox for Android from Play Store
2. Install Tampermonkey from Firefox Add-ons
3. Open Tampermonkey dashboard → + → paste the script → Save

Setup

1. Get a free Groq API key at console.groq.com/keys
2. Open any OpenCode web page
3. Open Violentmonkey/Tampermonkey menu → "Set Groq API Key"
4. Paste your key (gsk_...)

Usage

1. Open OpenCode web in your browser
2. A microphone button appears next to the chat input
3. Tap the button to start recording (red pulse + timer)
4. Tap again to stop — audio is transcribed and inserted into the input
5. (Desktop) Press Ctrl+Space as an alternative to clicking

Configuration

All settings available via the Violentmonkey/Tampermonkey menu:

Menu Item	Description
Set Groq API Key	Enter your gsk_... key
Toggle Auto-Submit	Auto-send message after transcription
Set Whisper Model	whisper-large-v3 (default) or whisper-large-v3-turbo (faster)
Set Language	Language code (e.g., ru, en) or empty for auto-detect
Set Whisper Prompt	Context prompt for transcription accuracy

---

Русский

Возможности

• Whisper large-v3 транскрипция через Groq API (качество как в Cursor)
• Tap-to-toggle запись (тапнул — начал, тапнул — стоп)
• Шумоподавление + эхоподавление (для записи на улице)
• Таймер записи (формат MM:SS)
• Ctrl+Space горячая клавиша на ПК
• Кастомный Whisper prompt для контекста разработки
• Авто-определение языка (русский + английские технические термины)
• Авто-отправка опционально (настраивается)
• Без бэкенда — запросы идут напрямую из браузера через GM_xmlhttpRequest

Требования

Компонент	Требование
OpenCode	Запущенный веб-интерфейс (opencode web)
Groq API ключ	Бесплатно на console.groq.com/keys
Браузер ПК	Vivaldi / Chrome / Firefox + Violentmonkey или Tampermonkey
Браузер телефон	Firefox для Android + Tampermonkey

Совместимость

Платформа	Браузер	Менеджер скриптов	Статус
Десктоп (Linux/macOS/Windows)	Vivaldi	Violentmonkey	✅ Поддерживается
Десктоп	Chrome	Tampermonkey	✅ Поддерживается
Десктоп	Firefox	Tampermonkey	✅ Поддерживается
Android	Firefox	Tampermonkey	✅ Поддерживается
Android	Vivaldi	—	❌ Нет поддержки расширений
Android	Chrome	—	❌ Нет поддержки расширений

Установка

ПК (Vivaldi + Violentmonkey)

1. Установите расширение Violentmonkey в Vivaldi
2. Откройте панель Violentmonkey → + → Создать новый скрипт
3. Вставьте содержимое dist/opencode-voice-dictation.user.js
4. Сохраните (Ctrl+S)

Android (Firefox + Tampermonkey)

1. Установите Firefox для Android из Play Store
2. Установите Tampermonkey из дополнений Firefox
3. Откройте панель Tampermonkey → + → вставьте скрипт → Сохранить

Настройка

1. Получите бесплатный ключ Groq на console.groq.com/keys
2. Откройте любую страницу OpenCode web
3. Откройте меню Violentmonkey/Tampermonkey → "Set Groq API Key"
4. Вставьте ваш ключ (gsk_...)

Использование

1. Откройте OpenCode web в браузере
2. Рядом с полем ввода появится кнопка микрофона
3. Тапните кнопку для начала записи (красная пульсация + таймер)
4. Тапните снова для остановки — аудио транскрибируется и вставляется в поле ввода
5. (На ПК) Нажмите Ctrl+Space как альтернативу клику

Настройки

Все параметры доступны через меню Violentmonkey/Tampermonkey:

Пункт меню	Описание
Set Groq API Key	Ввести ключ gsk_...
Toggle Auto-Submit	Автоматическая отправка после транскрипции
Set Whisper Model	whisper-large-v3 (по умолчанию) или whisper-large-v3-turbo (быстрее)
Set Language	Код языка (например, ru, en) или пусто для авто-определения
Set Whisper Prompt	Контекстный промпт для точности транскрипции

---

Development / Разработка

Prerequisites

• Node.js 22+
• npm

Setup

git clone https://github.com/slaid098/opencode-voice-dictation.git
cd opencode-voice-dictation
npm install

Commands

Command	Description
npm run dev	Development mode with auto-reload
npm run build	Build to dist/opencode-voice-dictation.user.js
npm run lint	Lint with Biome
npm run format	Format with Biome
npm run typecheck	TypeScript type checking
npm run test	Run tests with coverage (60% threshold)
npm run knip	Find unused code

Project Structure

src/
├── index.ts        # Entry point — orchestrates all modules
├── config.ts       # GM storage, defaults, validation, menu commands
├── audio.ts        # MediaRecorder, getUserMedia, audio constraints
├── transcribe.ts   # Groq API call, FormData builder, error parsing
├── insert.ts       # Contenteditable text insertion + InputEvent dispatch
├── ui.ts           # Button injection, MutationObserver, toast notifications
├── keyboard.ts     # Ctrl+Space keyboard shortcut handler
└── types.ts        # Shared TypeScript types

tests/
├── transcribe.test.ts  # FormData format, error parsing (5 tests)
├── insert.test.ts       # Contenteditable insertion, event dispatch (5 tests)
├── config.test.ts       # Defaults, key validation, state (9 tests)
├── audio.test.ts        # Time formatting (5 tests)
└── __mocks__/$/         # Mock for GM_api functions

CI/CD

• Lint: Biome (recommended rules, noExplicitAny: error)
• Typecheck: tsc --noEmit
• Knip: Dead code detection
• Test: Vitest + happy-dom, 60% coverage threshold
• Build: Vite → single .user.js file
• Dependabot: Weekly npm + GitHub Actions updates

License

MIT — see LICENSE