Keyman Desktop Configuration can be run with command line arguments to simply automate a number of tasks.  It is also possible to use the Keyman Desktop API to accomplish all these tasks, but some are more easily accessed via the command line.

The command line program is kmshell.exe, and if run with no arguments kmshell will start Keyman Desktop.  Otherwise, the following command line arguments are available:

Argument Description
-c Start Keyman Configuration
-i filename [-s] Install a keyboard (.kmx) or package (.kmp) file (-s = silent)
-uk filename.kmx [-s] Uninstall a keyboard (.kmx file) (-s = silent)
-up filename.kmp [-s] Uninstall a package (.kmp file) (-s = silent)
-h Open Keyman Desktop help contents
-w Start Keyman Desktop tutorial
-t Start Keyman Desktop text editor
-ouc Check for updates online and prompt user if updates are found
-kw package Show help for the installed keyboard package
-kp keyboard Start print wizard for on screen keyboard for the keyboard
-activate key [-s] Activate Keyman Desktop (-s = silent)

If Keyman Configuration is run as an elevated command, then the command will run in local machine context, otherwise it will affect only the current user.

KMShell.exe may be found in %ProgramFiles%TavultesoftKeyman Desktop 8.0. On x64 operating systems, it may be found in %ProgramFiles(x86)%TavultesoftKeyman Desktop 8.0.

Categories: Using Keyman Desktop

0 thoughts on “Command line arguments for Keyman Configuration”

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Related Posts

Developing Keyman

Keyman 11.0 is now available

We have just released Keyman 11.0 for Windows, macOS, Linux, Android, iOS and web, as well as Keyman Developer, the keyboard development suite. Keyman for Linux is entirely new for version 11. For the other Read more…


Mitigation for Keyman, Windows 10 1803, and Amharic, Tigrinya and Sinhala issue

Background It recently came to our attention that under Windows 10 1803 and Windows 10 1809, Keyman keyboards simply do not work when associated with Amharic or Sinhala languages, and sometimes do not work with Read more…

Developing Keyman

How to send feedback to Microsoft for issues that impact Keyman

We report all issues in Windows that impact Keyman to Microsoft. If a particular issue impacts you, it is very helpful to “upvote” the issue or add further comments about the issue in the Feedback Read more…