Voltkit Manual GitHub
On this page

Configuration file

Voltkit's settings are in ~/.config/voltkit/config.toml. Every key is optional: Voltkit works without the file, and missing keys use the defaults. Snippets you add in the app are saved here, and after editing by hand you can run voltkit daemon reload for the service to re-read it.

A complete example#

# ~/.config/voltkit/config.toml

[hotkeys]
ocr = "<Super><Shift>t"
color_picker = "<Super><Shift>c"
snippets = "<Super><Shift>e"      # opens the snippet picker
qr = "<Super><Shift>q"            # scans a QR code on screen
ruler = "<Super><Shift>r"         # opens the screen ruler
smart_paste = "<Super><Shift>v"   # pastes the clipboard converted
zoom = "<Super><Shift>z"          # zooms into the screen and draws on it
shortcut_guide = "<Super><Shift>slash"   # shows the shortcut cheat sheet

[ocr]
lang = "eng"            # e.g. "eng+deu"; needs matching tesseract language packs

[compress]
quality = 80            # 1–100

[expander]
typed_triggers = false        # expand ;date etc. as you type; run `voltkit expander setup` first
paste_shortcut = "ctrl+v"     # or "ctrl+shift+v" / "shift+insert"

[zoom]
save_dir = "/home/you/Pictures/Screenshots"   # where Zoom & Annotate saves; empty means Pictures/Voltkit

[gpu]
price_per_kwh = 0.15          # your electricity price, to show what a GPU session cost
currency = "€"

[[snippets]]
trigger = ";date"
template = "{date:%Y-%m-%d}"

[[snippets]]
trigger = ";sig"
template = "Best regards,\n{arg:name}"

Sections#

SectionKeyMeaningDefault
[hotkeys]ocr, color_picker, snippets, qr, ruler, smart_paste, zoom, shortcut_guideThe global shortcuts, in the form <Super><Shift>tsee Global shortcuts
[ocr]langTesseract language code(s); join several with +eng
[compress]qualityDefault quality for JPEG, WebP and video, 1 to 10080
[expander]typed_triggersWhether typed triggers are on (use the page switch or voltkit expander setup to set it up)false
[expander]paste_shortcutWhat the picker presses to paste: ctrl+v, ctrl+shift+v (terminals) or shift+insertctrl+v
[zoom]save_dirThe folder where Zoom & Annotate saves pictures. Change it on the Zoom & Annotate page.Pictures/Voltkit
[gpu]price_per_kwh, currencyElectricity price and currency sign for session costsnot set
[[snippets]]trigger, templateOne snippet each; see Text Expansionthree examples

Other files#

PathWhat
~/.config/voltkit/gpu-profiles.jsonGPU profiles you edit in the app
~/.config/environment.d/90-voltkit.confEnvironment variables set in Hosts & Environment
~/.local/share/voltkit/Color history, daily hardware snapshots, gpu-sessions/, and the last Batch Rename (rename-undo.json)
/etc/voltkit/gpu.json, /etc/voltkit/gpu-profiles.jsonWhat the GPU service runs
/etc/hosts.voltkit-backupThe backup of the hosts file
/etc/udev/rules.d/70-voltkit-typed-triggers.rulesKeyboard access for typed triggers (only if you turned them on)
/etc/udev/rules.d/90-voltkit-wakeup.rulesUSB wake-up choices from Why Didn't It Sleep?

Environment variables#

VariableEffect
LANGUAGE, LANGThe language Voltkit uses
VOLTKIT_GPU_DEMO, VOLTKIT_REPORT_DEMO, VOLTKIT_SLEEP_DEMO…Show made-up data (used to make this manual's screenshots)