Skip to content

Installation

Leshiy edited this page Aug 27, 2026 · 3 revisions

Installation

Builds are published on the Releases page. Each release ships four installers (plus latest.json, which the in-app updater polls — you never download that one by hand).

The installers are currently unsigned. That is why Windows SmartScreen and macOS Gatekeeper warn on first launch — the workarounds below are expected, not a sign something is wrong. Code signing is planned.

Windows 10 / 11

  1. Download poltertype-<ver>-x86_64-pc-windows-msvc.msi.
  2. Double-click. It is a per-user install — no admin rights, no UAC prompt.
  3. If SmartScreen shows "Windows protected your PC" → More infoRun anyway.

macOS 11+ (Intel & Apple Silicon)

  1. Download poltertype-<ver>-universal-apple-darwin.dmg.
  2. Open the DMG, drag poltertype.app into /Applications.
  3. First launch: right-click the app → Open (or run xattr -dr com.apple.quarantine /Applications/poltertype.app).
  4. Grant Accessibility and Input Monitoring when macOS asks — details in macOS-Setup.

Validated on real hardware: macOS 15 on Intel, and macOS 26 on Apple Silicon (M1 Pro) at 0.19.0 — first launch, corrections, the force-switch hotkey and the self-update (#3).

Linux (x86_64 and aarch64)

  1. Download poltertype-<ver>-x86_64.AppImage, or poltertype-<ver>-aarch64.AppImage for ARM64 (Raspberry Pi 5, Asahi, ARM laptops and servers — built natively, not cross-compiled).
  2. chmod +x and run. Per-user, no system install.
  3. Wayland needs a one-time setup script (evdev/uinput access); X11 needs nothing at all — see Linux-Setup.

NixOS cannot exec a generic AppImage at all — there is no /lib64/ld-linux-x86-64.so.2 — so step 2 fails with "Could not start dynamically linked executable" before anything of ours runs. One setting fixes it, and the setup script writes it for you: see Linux-Setup.

Staying up to date

You install once. From then on PolterType checks GitHub for new releases daily, downloads your platform's installer in the background, verifies its SHA-256, and waits — the swap happens when you quit or click ⟳ Restart to update in the tray. It sends no account, no identifier, nothing about you or your typing; one checkbox on the Settings → General pane turns the whole mechanism off. Full details and caveats in the README.

Building from source

git clone https://github.com/Just-Code-NET/PolterType.git
cd PolterType
cargo run -p poltertype-app

The per-OS native dependency checklist is in CONTRIBUTING.md.

Clone this wiki locally