Home - zkwi/VoxType GitHub Wiki

VoxType Wiki - Rust/Tauri Windows AI Voice Typing App

本页面是 GitHub Wiki Home 的仓库内草稿镜像,用于避免线上 Wiki 与仓库文档长期漂移。

VoxType is a lightweight Rust/Tauri Windows desktop AI voice typing, dictation, and speech-to-text app. Put the cursor in any input box, press the global shortcut, speak, and VoxType will transcribe your voice with the selected ASR provider, optionally polish the result with an OpenAI-compatible LLM, copy it to the clipboard, paste it into the active field, and restore the previous clipboard when possible.

声写 VoxType 是一个基于 Rust/Tauri 的 Windows 桌面 AI 语音输入、语音转文字和听写工具。把光标放到任意输入框后,按全局快捷键开始说话,VoxType 会完成录音、当前 ASR 服务识别、可选大模型润色、写入剪贴板、自动粘贴和剪贴板恢复。

Use Cases / 适合场景

  • Windows voice typing and speech-to-text in chat apps, browsers, editors, forms, and office tools.
  • 中文语音输入、英文听写、多语言语音转文字,以及需要实时字幕的桌面输入场景。
  • Doubao ASR by default, optional Alibaba Cloud FunASR, and optional LLM polishing for cleaner long-form dictation.
  • A local-first open-source workflow with conservative privacy defaults.

Interface Preview / 界面预览

Home keeps the current input state, shortcut triggers, latest result notice, and input performance in one screen. 首页顶部集中展示语音输入状态和启动方式;识别完成后会提示已复制并尝试粘贴,并提供临时复制或查看本次识别文本的入口。

API Config shows setup health before the credential forms. API 配置页先展示 ASR 密钥、麦克风、粘贴方式、触发方式和隐私设置状态,再提供当前 ASR 服务与可选大模型测试入口。截图中的密钥已脱敏。

简体中文

English

Recommended Reading Order

  1. Configure the ASR provider first. Doubao ASR is the default; Alibaba Cloud FunASR is optional.
  2. Add hotwords and optional prompt preferences.
  3. Adjust daily preferences such as shortcut, paste mode, microphone, captions, startup, and tray behavior.
  4. Open config.toml only when troubleshooting low-level ASR, LLM timeout, caption geometry, or clipboard timing parameters.

Current Defaults Worth Knowing

  • Main trigger: Ctrl + Q.
  • Right Alt and middle mouse triggers: off by default.
  • Recent context and automatic hotword candidates: off by default.
  • Screen OCR context: on by default, current display by default, no persisted OCR text.
  • Optional LLM polishing: off by default; when enabled, thinking/reasoning is disabled with provider-specific adapters where supported.
  • ASR no-feedback fallback: defaults to 30 seconds and stops through the normal grace flow only when the provider returns no effective text feedback.
  • Doubao server endpointing example value: end_window_size = 800; Alibaba Cloud FunASR uses provider-specific sentence silence settings.
  • Update prompts provide an "Update now" action when a new installer is available.

Privacy Basics

  • config.toml, logs, local context files, and usage stats are local files and should not be committed.
  • Usage statistics record duration, character count, speed, and time estimates, not recognized text.
  • Recent context and automatic hotword history are disabled by default.
  • Screen OCR context is temporary and not written to logs, stats, config, or cache.
  • The Privacy & local data page shows config, logs, storage/upload boundaries, and can clear recent context, automatic hotword history, and usage stats.
  • Diagnostic reports and logs should not include real API keys, recognized text, hotwords, prompts, recent context, screen OCR text, automatic hotword history, or Windows username paths.

Search-Friendly FAQ

Is VoxType a Windows dictation app?

Yes. VoxType is a Windows desktop dictation app that turns microphone speech into text and pastes it into the active input field.

Does VoxType require Doubao ASR?

No. VoxType uses Doubao ASR by default, but you can switch to Alibaba Cloud FunASR in API Config. The selected ASR provider's required credentials must be filled before recording, recognition, and paste actions are unlocked.

Is LLM polishing required?

No. LLM polishing is optional. VoxType can run as a pure ASR voice input tool, and only calls an OpenAI-compatible LLM when polishing is enabled and configured.

Which LLM model should I use?

Start with qwen3.7-max on DashScope/Bailian for daily polishing, or qwen3.6-flash-2026-04-16 when latency matters more than edge-case accuracy. After changing Base URL, API Key, model, or the thinking toggle, VoxType automatically reruns the LLM adapter test after auto-save and saves the fastest strategy; you can still rerun it manually when troubleshooting. For code paths, filenames, and identifiers, prefer screen OCR, hotwords, or a manual check instead of relying on a model switch alone.