User Tools

Site Tools


Execute Swift Script

The Execute a Swift Script action executes a specified Swift script, either from a file or text.

Using the Results

The results of the script can be:

  • Ignored.
  • Displayed in a floating window.
  • Displayed briefly in a Notification.
  • Typed in to the current selection.
  • Pasted in to the current selection.
  • Saved to a variable.
  • Saved to the system or a Named Clipboard.
  • Asynchronously ignored — the action runs while the macro continues on.

How to Get Keyboard Maestro Variables

Keyboard Maestro sets the environment variables for the script to include all your variables, using a prefix of KMVAR_ and your variable name with spaces changed in to underscores (_). For example, your Keyboard Maestro “File Name” variable will be available as the environment variable KMVAR_File_Name.

By default, all variables are included, but you can select No Variables, or specific variables as desired using the popup menu next to the script (v11.0+).

Swift scripts can get (but not set) Keyboard Maestro Variables by using environment variables, for example:

Swift 2 (Xcode 7 and 8)

import Foundation

Swift 3 (Xcode 8)

import Foundation

Swift scripts can get or set Keyboard Maestro Variables by using AppleScript, for example:

import Foundation
let myString = "the Value"
NSAppleScript(source: "tell application \"Keyboard Maestro Engine\" to setvariable \"fromSwift\" to \"\(myString)\"")?.executeAndReturnError(nil)

Note that if the value might contain backslashes or quotes, you will need to deal with quoting them, replacing every backslash with backslash-backslash, and every double quote with backslash-double quote.

See Also


Forum Topics

action/Execute_a_Swift_Script.txt · Last modified: 2023/09/12 23:03 by peternlewis