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 *

Related Posts

Developing Keyman

Keyman is now free and open source

SIL International is very pleased to announce that Keyman is now completely free and open source! Today, 23 August 2017, we released free versions of the existing Keyman products on the Keyman website, and have Read more…

Using Keyman Desktop

Activation of Keyman Desktop for Network Administrators

This is a quick technical note on different ways to activate Keyman Desktop for system administrators. Activation using a command line tool The simplest way is using the command line for kmshell.exe (located in Program Files Read more…

Using Keyman Desktop

Working through Malayalam display in Windows

Some Keyman users have recently brought to our attention inconsistencies in the appearance of Malayalam text when viewed with different fonts.  Although this has become more apparent with the release of new versions of  Keyman Read more…