BACKGROUND
If you are looking for a full-featured back-up tool, I suggest you check out:
There may be others that I've missed.
This macro was inspired by @ronald's idea in this thread.
DESCRIPTION
This macro provides a quick and simple method to back-up the macros listed in any Smart Group. All exported macros will be zipped into a single archive. The archive name includes:
- Date & time
- Smart Group name
- macro count
zipextension
For example, for Smart Group Cre Mod 7d:
2025-01-22 0944_48 [Cre Mod 7d] (43 macros).zip
This macro uses the following Keyboard Maestro Editor native feature: File > Export > Export as Folder.... As mentioned above, this macro then subsequently zips the newly created folder.
One nice feature of Export as Folder... is that it maintains the Macro Group hierarchy when the macros are exported. Thus, even though this macro keys off Smart Groups, the backup has a subfolder for the parent Macro Group of each macro backed up.
Since the macro is quick and simple, it's an ideal tool to use during macro development.
For example, one could create a Smart Group named Cre Mod 4h with two match strings, cre:4h and mod:4h, then run this macro and select that Smart Group. In just a few seconds all macros created or modified within the last 4 hours, would be saved within a single zip file.
Since the macro provides an option to reveal the archive in the Finder after creation, it becomes very easy to manage the archive files.
SETTINGS
> local_BackupRootPath
All backup zip files will be be written to this folder. If they do not exist, the sub folders in the path (below home: ~) will be created by the macro. The default is:
~/Documents/Automation/_Keyboard Maestro/Backups
If this path is not specified, the archive file will be written to: ~/Downloads
> local_SmartGroupPatterns
This variable can be optionally used to limit the Smart Groups displayed for backup. Each line is used as a Regular Expression pattern.
If nothing is specified (the default), the macro will provide an option to back up any of the Smart Groups.
> local_DefaultFeedbackWhenCalled : [dialog] | [reveal] | [none]; default [reveal] : when this macro is triggered from another macro or via AppleScript, the action that follows the creation of each zip file:
-
[dialog]: A dialog will appear after the Smart Group is archived to a zip file. If multiple Smart Groups are specified, then the final dialog will also include a Reveal button . -
[reveal]: No dialogs will appear, however, the zip file created will be revealed in the Finder. If multiple Smart Groups are specified, then the last created zip file will be revealed. -
[none]: Aside from the normal Export to Folder... notification, there will be no feedback.
In all cases, when the macro completes, the Keyboard Maestro Editor will be returned to its initial state including the selections within the Groups and Macros columns.
> local_DropboxSafe : 0|1; default 0 : The zip file name and exported macro groups and macros will be renamed to avoid characters that are problematic for Dropbox (/, \, <, >, :, ", |, ?).
On a related note, Keyboard Maestro Export as Folder... automatically changes colons (:) and slashes (/) to dashes (-) in macro groups and macros to maintain compatibility with macOS file names.
This macro also changes any leading dots (.) to dashes (-) so that the group or macro is visible in the Finder.
USING ANOTHER MACRO TO TRIGGER
This macro can be triggered using the Execute a Macro action in another macro; the Smart Group(s) are specified using the With Parameter, one Smart Group Name or UUID per line. In this mode, the Smart Groups Prompt With List will not be displayed. Since the setting local_SmartGroupPatterns does not apply in this mode, the macros in any configured Smart Group can be zipped.
In addition to the Execute a Macro action, the primary macro can be triggered using AppleScript within or outside Keyboard Maestro. Here's an example zipping two Smart Groups:
-- Zip Smart Group(s)
property theP : "4-Cre Mod 7d
F542D717-B0F7-4361-B44B-E16892686B67"
tell application "Keyboard Maestro Engine"
do script "43C753A4-C71C-45DD-9F65-346DB1A8350A" with parameter theP
end tell
Note that in this example a Smart Group name is used for the first Smart Group, and a UUID is used for the second. (See property theP.)
Lastly, the first line of With Parameter can optionally be [dialog], [reveal], or [none]. See the local_DefaultFeedbackWhenCalled setting for more information.
TESTED WITH
• Keyboard Maestro 11.0.3
• Sequoia 15.3 (24D5034f)/MacBookPro18,2
• Mojave 10.14.16/Macmini6,2
• High Sierra 10.13.6/iMac11,1445
VERSION HISTORY
( expand / collapse )
1.0 - initial version
2.0
a) Macro can now be called using the Execute a Macro action and the Smart Group(s) can be specified using the With Parameter, one Smart Group Name or UUID per line.
b) Macro name changed from Zip a Smart Group to Zip Smart Group(s).
3.0
a) Added feedback dialog if an empty Smart Group is selected.
b) Reduced pause durations. For those using a very slow mac, it might be necessary to increase them.
c) Improved efficiency and readability of the JXA code that gathers the Smart Group information.
d) Fixed a dialog typographical error.
4.0
a) Moved the macro to a group that can be run regardless of the running state of the Keyboard Maestro Editor. When the macro completes, the Keyboard Maestro Editor will be returned to its initial state including the selections within the Groups and Macros columns.
b) After the macros are exported and before they are zipped into an archive, macro groups and macro names are changed by substituting any leading dots (.) to a dash (-). This change makes the folders/files visible in the Finder.
c) Added setting local_DropboxSafe. If 1, the zip file name and exported macro groups and macros will be renamed to avoid characters that are problematic for Dropbox.
d) If the macro is triggered directly, multiple Smart Groups can be selected and a dialog will appear for each Smart Group; the last dialog will include a Reveal button. If selected, the last zip file created will be revealed in the Finder. In contrast, if the macro is triggered from another macro or via AppleScript, by default no dialogs will appear and the zip file will be revealed.
e) Added setting local_DefaultFeedbackWhenCalled with options of [dialog], [reveal], or [none].
f) As with previous versions of this macro, if triggered from another macro or via AppleScript, one or more Smart Group names and/or UUID's can be specified using the With Parameter (one per line). With this macro update, the first line of With Parameter can optionally be [dialog], [reveal], or [none] to specify the post-zip feedback. If not included, the value of local_DefaultFeedbackWhenCalled will be used.
LISTS AND DIALOGS
If the macro is triggered directly, a Prompt With List like the following will appear. (By default, all Smart Groups are listed. The list can be limited using an optional macro setting.) One or more (with ⇧+click or ⌘+click) Smart Group(s) can be selected.
By default, a dialog will appear for each Smart Group exported and zipped.
The last dialog will include and option to reveal the zip file.
If the macro is triggered from another macro using the Execute a Macro action and one or more Smart Groups are specified (by Name or UUID), the above Prompt With List is skipped and the backups immediately commence.
As depicted above, the first line of With Parameter can be used to specify the post-zip feedback. If not included, the value specified in a macro setting will be used.
DOWNLOADS
PRIMARY MACRO
Download: Zip Smart Group(s).kmmacros (131 KB)
Macro-Notes
- Macros are always disabled when imported into the Keyboard Maestro Editor.
- The user must ensure the macro is enabled.
- The user must also ensure the macro's parent macro-group is enabled.
System Information
- macOS 15.3 (24D5055b) PRE-RELEASE SEED SOFTWARE
- Keyboard Maestro v11.0.3
