Installation¶
Voktty is distributed as a desktop application for Windows, macOS and Linux. Download the latest installer from the GitHub Releases page. Voktty includes an auto-updater configured for published releases.
Platform notes¶
Windows¶
The installer runs in current-user mode and does not require administrator access. WebView2 is bundled through the installer configuration for offline installation. The shell preference is:
- PowerShell 7 (
pwsh.exe) - Windows PowerShell (
powershell.exe) - Command Prompt (
cmd.exe)
WSL distributions are exposed as workspace environments rather than as a shell command wrapped inside a local terminal.
macOS¶
Use the macOS artifact that matches the published release. Voktty uses a native title-bar overlay and window vibrancy on macOS. The current configuration uses a private macOS API for vibrancy, so the build is not intended for Mac App Store distribution.
Linux¶
The release includes AppImage, deb and rpm artifacts when available. The AppImage needs FUSE. If FUSE is unavailable, run it with:
./Voktty_*.AppImage --appimage-extract-and-run
On Wayland, set WEBKIT_DISABLE_DMABUF_RENDERER=1 if the webview renders incorrectly. The deb and rpm packages use the system GTK and WebKitGTK stack.
For Arch-based systems, the community package can be installed with yay -S voktty-bin or paru -S voktty-bin when the package is current. Nix users can install the flake with:
nix profile install github:voktty/voktty
Build from source¶
Use the source build when you want to develop Voktty or test a branch.
Prerequisites¶
- Node.js 20 or newer
- pnpm
- Rust stable through rustup
- The Tauri platform prerequisites
Run the development app¶
pnpm install
pnpm tauri dev
Build a release bundle¶
pnpm install
pnpm tauri build
See Local setup for platform-specific development details and verification commands.
Updating¶
When auto-update is enabled, Voktty checks the configured release endpoint and presents an update action in the application. Manual installers remain available from GitHub Releases when an update is unavailable or when you need to pin a version.