gyute.fyi Yap home
Getting started
Clanker Yap overview

Get started

Using Clanker Yap

Contribute

Get started

Getting started

2 min read

This guide covers running Clanker Yap on Linux.

Platform status

Current release targets:

  • Linux x86_64 — AppImage

Tested environments:

  • Linux (Wayland): smoke tested
  • Linux (X11): smoke tested
  • Windows/macOS: not supported release targets

System requirements

Linux packages

Arch / CachyOS

sudo pacman -S --needed base-devel cmake webkit2gtk-4.1 libappindicator-gtk3 librsvg nodejs npm

Debian / Ubuntu

sudo apt install build-essential cmake libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev nodejs npm

Fedora

sudo dnf install gcc-c++ cmake webkit2gtk4.1-devel libappindicator-gtk3-devel librsvg2-devel nodejs npm

Also required:

  • Rust stable toolchain
  • Node.js and npm

Installation

1. Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default stable

2. Clone and install dependencies

git clone https://github.com/Bynzski/clanker-yap.git
cd clanker-yap
npm install

3. Get a Whisper model

Clanker Yap expects a local GGML Whisper model.

Default path:

~/.local/share/voice-transcribe/ggml-base.en.bin

You can either:

Running the app

Development

npm run tauri:dev

Production AppImage build

npm run tauri:build

Output:

src-tauri/target/release/bundle/appimage/Clanker Yap_X.Y.Z_amd64.AppImage

Run it with:

chmod +x "src-tauri/target/release/bundle/appimage/Clanker Yap_X.Y.Z_amd64.AppImage"
./src-tauri/target/release/bundle/appimage/Clanker\ Yap_X.Y.Z_amd64.AppImage

First launch

On first launch, the app will:

  1. initialize the SQLite database
  2. set the default hotkey to Ctrl+Shift+V
  3. use the default model path unless you change it
  4. request microphone permission if your environment requires it

Basic usage

  1. Open any app where you want text inserted
  2. Hold the configured hotkey
  3. Speak into your microphone
  4. Release the hotkey
  5. Clanker Yap transcribes locally and pastes the result

What you can configure

  • Hotkey — push-to-talk shortcut
  • Model — local Whisper model path
  • Mic — audio input device
  • Paste mode — Auto, Standard, or Terminal
  • History — recent transcriptions

Need more help?