Skip to content

Configuration

Reference Yap's actual JSON settings, platform data directories, hotkey values, and development-only environment overrides.

Data directories

Yap uses Go’s os.UserConfigDir() and appends yap:

PlatformDefault data folder
macOS~/Library/Application Support/yap/
Windows%APPDATA%\yap\
Linux$XDG_CONFIG_HOME/yap/, or ~/.config/yap/ when unset

Inside that folder:

PathContents
config.jsonProvider, keys, microphone, and behavior settings
models/ggml-*.binDownloaded Whisper models
history.jsonRecent transcripts and audio references
recordings/Saved 16 kHz mono WAV audio
stats.jsonUsage statistics
logs/Diagnostic logs

The Windows portable app uses this same data directory. Its ZIP extraction folder is not a portable data profile. Clearing History does not erase all audio; see history deletion.

Configuration fields

Prefer Settings over manual edits. Quit Yap before changing config.json, and preserve fields you do not intend to change.

FieldType / defaultMeaning
providerstring, locallocal or openai
modelstring, base.enActive local model identifier
openaiApiKeyoptional stringOpenAI API key stored in plain JSON
audioInputDeviceoptional stringDevice name; empty uses system default
autoPasteboolean, trueCopy and simulate paste; false copies only
recordingHotkeystringrightoption on macOS, rightalt on Windows/Linux
cancelHotkeystring, escapeCancel an active recording
soundEnabledboolean, trueRecording sound feedback; omitted also means enabled
onboardingCompletedboolean, falseWhether first-run setup has completed
showNotificationboolean, truePersisted field; not a guarantee of an implemented notification feature
favoriteModelsoptional string arrayStarred Models Library identifiers
saveTranscriptionsboolean, falseSave successful transcriptions as individual UTF-8 text files
transcriptionOutputDirstring, emptyAbsolute path to an existing writable folder for transcription text files

Choose the output folder through Settings before enabling saving. These fields apply to future successful transcriptions, not an export of existing history. The chosen folder is independent of the Yap data directory; history deletion and clearing do not remove its files. See transcription files.

Hotkey values are lowercase single-key names such as rightoption, rightalt, escape, or f9. Use the key capture UI to choose supported keys; rightOption and doubleTapRightOption are not the values to copy from older docs.

Example settings fragment for Windows/Linux (merge into the existing file, do not replace it blindly):

{
  "provider": "local",
  "model": "base.en",
  "autoPaste": true,
  "recordingHotkey": "rightalt",
  "cancelHotkey": "escape",
  "soundEnabled": true
}

Use rightoption instead of rightalt for the macOS default. See models for valid model names.

Credentials

The OpenAI key is not encrypted or stored in a system keychain. Do not share config.json, and remove credentials from diagnostic bundles. Protect backups of this file as you would the original key.

Development overrides

Available in 0.5.0 (not in older 0.4.2 builds):

  • YAP_CONFIG_DIR: override the complete Yap data directory to isolate a development profile.
  • YAP_MODEL_BASE_URL: override the model-download base URL, useful for a local test server. It must provide the catalog’s ggml-*.bin filenames.

The previously documented WHISPER_CPP_PATH environment variable is not read by the reviewed code. Do not rely on it. See building for runtime discovery and packaging.

Reset settings

Quit Yap and rename or back up config.json, then restart to create defaults. This resets onboarding and preferences. Do not remove the whole data directory unless you also intend to remove models, history, recordings, and logs.