User Tools

Site Tools


Tokens

Tokens

Definition

Tokens in Keyboard Maestro represent placeholders, that you enter during design time, for information that will be replaced in the text at run time. For example, you could enter the %SafariTitle% token in a Set Variable to Text Action, and when you trigger the macro it will be replaced with the title of the current Safari tab. So the value of the Token will be determined at execution time. All tokens return a text value, even if the source data was some other data type.

Tokens allow you to add textual information to token text fields. You can insert tokens into a field using the Insert Token popup near the field or by choosing Insert Token from the Edit menu. You can also start typing a token and use text completion to complete the token.

Text Processing

You can use the following special formats to process text or to return non-printing characters:

  • Convert Case of Text
  • Return Non-Printing Characters
    • Convert: \a \b \e \f \t \r \n
    • To: bell, backspace, escape, form feed, tab, return, line feed.
  • Convert Hex Code to Unicode Characters
    • Use Hex Codes in this format: %NN% or %NNNN%
  • Escape Special Characters
    • Use %% to return a single % as plain text
    • Use \\ to return a single \ as plain text

List of Tokens

How To Use

Keyboard Maestro has a wide variety of tokens. Tokens allow you to add information to text fields in an Action. You can insert tokens into a field using the Insert Token popup near the field.

Most fields that contain text (ie, not just numbers) can include tokens.

Action fields that accept tokens also process %NN% or %NNNN% as arbitrary hex unicode characters (eg %41% is an A), and (except for regular expression fields) process backslashed characters \a,\b,\e,\f,\t,\r,\n (bell,backspace,escape,form feed,tab,return,line feed).

To include a percent (%) in your text, simply double the percent (%%). To include a backslash (\) in your text, double the backslash (\\).

Tokens.txt · Last modified: 2019/09/22 09:06 by peternlewis