Browse the docs

Debugger action

Pauses a debugged run before the next step, or leaves a note in the Trace.

Debugger: action

Keyboard Maestro: Debugger actions, DebuggerAction

Details #

Connects a macro to Switchboard's debugger. When the macro is run under the debugger, certain actions make it pause before the next step, like a breakpoint. When no debugger is attached, or the action is one of the others, the step only leaves a note in the Trace and does nothing else.

These actions pause a debugged run: start, breakpointThis, toggle, stepIntoOthers, stepOverOthers and stepOutOthers.

Any other action name, including note (the default when you give none), writes a note into the Trace. The note says the action has no meaning outside Keyboard Maestro's own debugger, plus your note text if there is one. The step's output is the action name.

Parameters #

ParameterTypeRequiredValuesWhat it does
actiontextThe debugger action, as listed above. Default note. The importer also writes finish, breakpointEvery, breakpointOthers, continueThis, continueEvery, newMacrosPaused and newMacrosRun; these only leave notes.
notetextFree text added to the Trace note when the step does not pause.

Every step also accepts label, onFailure, timeout and dryRunSafe.

Examples #

Leave a note in the Trace
Do
  1. Debugger: note
  2. Show “Check the Trace for a debugger note” for 2 s
Open in Switchboard to try it

Gotchas #

  • Outside a debugged run, a pause action is only a note. The Trace says "no debugger is attached to this run".

  • In a dry run the step is simulated unless it is marked dryRunSafe.

See also #

Log message, Throw error