Basic operation

Common

ksm <command> [<options>|--help]

For macOS, Linux users

If you don’t have permission to execute ksm.sh, you need to set it up with chmod command

Example

chmod 755 ksm.sh

new

Create a new keyswitch definition file(Yaml)”

ksm new <output-path>

Parameter	Description	Required	Default
output-path	Output file path	no	(ProductName).yaml

Note

Output according to the extension of the file name.

yaml:

Yaml

xlsx:

Spreadsheet(xlsx)

find

Searches for the keyswitch information data in the database from the specified parameters (partial match) The output format of the search results is Yaml

ksm find -f <path> -i <path> [ -d <name> | -p <name> | -i <name>]

Option (short)	Option (long)	Description	Required	Note
-d	–developer	Developer name to search
-p	–product	Product name to search
-i	–instrument	Instrument/Patch name to search
-f	–database	Database file	yes
-o	–output	Search result (Yaml file name describing the keyswitch information)	yes

Example

ksm find -d "Devloper Name" -p "My Guitar" -i "Guitar1" -f KeySwitches.db -o result.yaml

Use of asterisks (*)

If no search condition is specified, or an asterisk is specified, all will be searched.

Example

Search for keyswitches that contain the product name “Guitar” across all developers.

ksm import-xlsx -d "*" -p "Guitar" -f KeySwitches.db -o result.yaml

delete

Deletes the keyswitch information data in the database from the specified parameters.

ksm search -f <path> -i <path> [-d <name> | -p <name> | -i <name>]

Option (short)	Option (long)	Description	Required
-d	–developer	Developer name to search	yes
-p	–product	Product name to search	yes
-i	–instrument	Instrument/Patch name to search	yes
-f	–database	Database file	yes

Example

ksm delete -d "Devloper Name" -p "My Guitar" -i "Guitar1" -f KeySwitches.db