Home

Welcome to the keyman wiki! This wiki contains information for programmers and testers working on the Keyman project. For Keyman documentation, see https://help.keyman.com/

---

Some shortcuts to pages in this wiki:

API documentation

• api.keyman.com keyboard model package version API
• downloads.keyman.com history API
• downloads.keyman.com keyboard API
• downloads.keyman.com model API
• downloads.keyman.com version API
• Keyboard Processor API (KPAPI) temp reference
• history.md format
• KMP Metadata File (kmp.inf and kmp.json)
• Permalinks for keyboards

Testing

• How to test artifacts from pull requests for Keyman for Linux
• How to downgrade to latest stable version of Keyman for Linux
• How to uninstall Keyman for macOS for testing

User testing

• User Testing

Platform acceptance tests

• Platform Acceptance Test for Android

• Platform Acceptance Test for Developer

• Platform Acceptance Test for iOS

• Platform Acceptance Test for Linux

• Platform Acceptance Test for Mac

• Platform Acceptance Test for Web

• Platform Acceptance Test for Windows

• Baseline Configurations

Documentation for Developers

• Keyman Code Style Guide
• Keyman Project Scopes
• Principles of Keyman Code Changes
• Pull Request and Commit workflow notes
• User Testing

Setup

• How to set up a local web server for the Keyman web pages
• How to setup conventional commits git commit msg hook
• Linux Build Agent Setup
• macOS Build Agent Setup
• Windows Build Agent Setup

Troubleshooting/Debugging

• Crowdin CLI
• Making sense of the Windows Layout Registration
• kmtip and keyman32 interactions
• Delphi Debugging kmshell
• Test Installed desktop Keyboards with Keyman Developer Test Page -including TSF

Workflow

• Notes on preparing history files
• Release workflow
• Sentry workflow
• Updating Desktop and Developer for Unicode Releases

Miscellaneous

• Keyboard bundles build on demand
• Keyman 13.0 to 14.0 Migration
• Keyman 15.0 New Functionality