Documentation

Guides and reference

How the background service and the Settings window work, how to customise corrections, and how licensing and updates are handled.

  1. 01FoundationGetting Started & Cross-Platform InstallationInstall Typen on Windows (stable), macOS or Linux (public beta), understand the tray service and Settings window, grant the OS permissions each platform needs, and check that corrections are live.5 min read
  2. 02Core ArchitectureCore Typing Engine, Suffix-Diff Replacement & Undo MechanicsDeep dive into InputSessionManager, SuffixDiffPlanner, retroactive two-word homophone repair, sentence capitalisation, and deliberate double-Backspace undo.6 min read
  3. 03Desktop App10-Screen Desktop Customisation UI & Local IPC GuideWalkthrough of all 10 screens in the PySide6-Essentials + Qt Quick/QML Settings application and the authenticated Local IPC protocol.7 min read
  4. 04FeaturesProductivity: Snippets, Domain Packs & App ProfilesExpand text snippets with dynamic date/time macros, enable the 6 specialized domain vocabulary packs, and tailor typing behaviour per application.5 min read
  5. 05FeaturesAI: Layer 2 Local Models & Layer 3 BYOK Cloud AIHardware-aware local ONNX/GGUF sentence analysis (400ms Pause Pill & Ctrl+Shift+R hotkey) and consent-gated BYOK Cloud AI with hard USD spending limits.6 min read
  6. 06SecuritySecurity, Privacy & Cryptographic Update ArchitectureHow Typen guarantees zero keystroke logging, automatic password field exclusion, Ed25519 manifest verification, and atomic Zstandard delta updates.5 min read
  7. 07ProjectOpen Source, Free for Everyone, Funded by DonationsTypen is MIT-licensed with a single edition and no trial, licence key or activation. How the project is funded, what changed from the earlier commercial betas, and how to contribute.3 min read
  8. 08DevelopersCLI Entry Points, Local Sandbox & Lexicon Pipeline ReferenceCommand-line reference for autocorrect-daemon, autocorrect-settings, autocorrect-sandbox, and the ESDB/SCOWL binary lexicon compiler (autocorrect-pipeline).5 min read