Quick Start

Quick start

1. Start the daemon and reload Fcitx5

systemctl --user enable --now vinput-daemon.service
fcitx5 -r

2. Enable in Fcitx5

Open Fcitx5 Configuration → Addons → Find Vinput → Enable.

3. Install a model

Open Vinput GUI (launch from your application menu, or run vinput-gui in a terminal).

Go to Resources → Models, browse the available models list and click Download to install one, then click Use to activate it.

Or use the CLI:

vinput model list -a            # Browse available models
vinput model add <model-name>   # Download and install
vinput model use <model-name>   # Set as active model

You can also manually place a model directory in ~/.local/share/vinput/models/<model-name>/ containing:

vinput-model.json
model.int8.onnx or model.onnx
tokens.txt

4. Start using

Tap Alt_R to start recording, tap again to stop and recognize
Hold Alt_R to record, release to recognize (push-to-talk)

ASR providers

Besides the built-in local model, you can install cloud ASR providers for different speed, quality, or cost trade-offs.

In Vinput GUI, go to Resources → ASR Providers, browse available providers and click Install. Or use the CLI:

vinput provider list -a        # List available remote ASR providers
vinput provider add <id>       # Install a provider from registry
vinput provider use <id>       # Switch active ASR provider

Press F8 at any time to open the ASR provider / model switcher and switch between them on the fly.

Available cloud ASR providers include:

Provider	Mode	Description
doubao	non-streaming	Doubao / Volcengine fast file recognition
ElevenLabs	non-streaming / streaming	ElevenLabs speech-to-text API
alibai (Aliyun Bailian)	non-streaming / streaming	Qwen3-ASR via OpenAI-compatible / Realtime API
doubao (streaming)	streaming	Doubao ASR Realtime via AI Gateway
doubao-ime (streaming)	streaming	Unofficial Doubao IME real-time protocol
OpenAI-compatible	non-streaming / streaming	OpenAI `/v1/audio/transcriptions` or Realtime WebSocket

Key bindings

Key	Default	Function
Trigger Key	`Alt_R`	Tap to toggle recording; hold to push-to-talk
Command Key	`Control_R`	Hold after selecting text to modify with voice
ASR Menu Key	`F8`	Open ASR provider / model switcher
Scene Menu Key	`Shift_R`	Open scene switcher
Page Up / Down	`Page Up` / `Page Down`	Navigate candidate list
Move	`↑` / `↓`	Move cursor in candidate list
Confirm	`Enter`	Confirm selected candidate
Cancel	`Esc`	Close menu
Quick Select	`1`–`9`	Quick-pick candidate

All keys can be customized in Fcitx5 configuration.

Configuration files

File	Path
Plugin config (keybindings, etc.)	`~/.config/fcitx5/conf/vinput.conf`
Core config (model, LLM, scenes)	`~/.config/vinput/config.json`
Model directory	`~/.local/share/vinput/models/`
ASR provider scripts	`~/.local/share/vinput/providers/`
LLM adapter scripts	`~/.local/share/vinput/adapters/`

Flatpak installs use different paths:

File	Path
Plugin config	`~/.var/app/org.fcitx.Fcitx5/config/fcitx5/conf/vinput.conf`
Core config	`~/.var/app/org.fcitx.Fcitx5/config/vinput/config.json`
Model directory	`~/.var/app/org.fcitx.Fcitx5/data/vinput/models/`
ASR provider scripts	`~/.var/app/org.fcitx.Fcitx5/data/vinput/providers/`
LLM adapter scripts	`~/.var/app/org.fcitx.Fcitx5/data/vinput/adapters/`