Voltkit Manual GitHub
On this page

A tour of the app

Open Voltkit from your apps. This page explains the window, the menu, the banners and the habits shared by every tool.

The About dialog
The About dialog

The window#

  • The sidebar on the left lists the eighteen tools, in alphabetical order for your language, each with an icon. Select one to open its page. Hover over a tool to see a one-line description.
  • The page shows the tool's name and a short description at the top, then its controls. Pages use two columns on a wide window and one column on a narrow one; every page scrolls on its own.
  • On a narrow window (under about 600 pixels) the sidebar becomes a list you go back to with the window's back button, like on a phone.
  • The window follows your system's light or dark appearance.

The header buttons#

ButtonWhat it does
? (Help)Opens this manual in your web browser, on the page for the tool you are using. The shortcut is F1.
☰ (Main Menu)Help & Manual, About Voltkit and Quit

Help & Manual#

Opens this manual's home page, https://arios4k.github.io/voltkit/manual/.

About Voltkit#

Shows the version (click it to copy the version information), links to the project and to Report an issue, a More from the same author group with links to the author's other apps (ThermalPrint and Battery Health Center), the author's name, and the MIT License, which is free to use, modify and share.

Quit#

Ctrl+Q closes the window. Voltkit's background service keeps running, so the keyboard shortcuts, Keep Awake and typed triggers keep working. To stop the service too, run voltkit daemon stop.

Banners#

A banner may appear at the top of a page:

  • The background service is off, so keyboard shortcuts won't work with a Start button. Click it to start the service. See Global shortcuts and the background service.
  • N feature(s) need attention with a Details button. It lists what is missing, for example a helper program or a language pack, and offers Copy Command: the exact install command for your distribution, ready to paste in a terminal. The full report is voltkit doctor. See Troubleshooting.

Notifications and toasts#

  • Results of shortcuts (copied text, a picked color) appear as desktop notifications, because the window may be closed.
  • Actions in the window show a short toast at the bottom (Copied #7C3AED, Saved…). Some toasts have an Undo button.

Keyboard shortcuts#

Global shortcuts work from any app while the background service runs:

ShortcutAction
Super+Shift+TText Extractor: drag a box around text
Super+Shift+CColor Picker: pick a color
Super+Shift+EText Expansion: open the snippet picker
Super+Shift+QQR Code: scan a code on screen
Super+Shift+RScreen Ruler: measure on screen
Super+Shift+VSmart Paste: paste converted
Super+Shift+ZZoom & Annotate: zoom into the screen and draw on it
Super+Shift+/Shortcut cheat sheet

You can change them in the configuration file or with Shortcut Detective. Inside the app: F1 opens help and Ctrl+Q quits.

Language#

Voltkit follows your session's language: English, Spanish, German, French and Simplified Chinese. To try another one for Voltkit only, start it from a terminal:

LANGUAGE=fr voltkit    # or es, de, zh_CN, en

Accessibility#

Controls have text labels for screen readers, decorative icons and charts are hidden from them (charts also have a description), disabled controls say why they are disabled, and everything can be reached with the keyboard. If you find something that does not work with your assistive technology, please open an issue.

Where Voltkit keeps things#

WhatWhere
Settings and snippets~/.config/voltkit/config.toml
GPU profiles you edit~/.config/voltkit/gpu-profiles.json
Environment variables you set~/.config/environment.d/90-voltkit.conf
Color history, hardware snapshots, GPU sessions~/.local/share/voltkit/
Hosts file backup/etc/hosts.voltkit-backup
GPU service settings/etc/voltkit/

See Configuration file.