Skip to main content

Metadata Reference

Metadata are comments at the top of your scripts. You have most likely encountered

// Name: ...

and

// Description: ...

before.

There are many more of these options that control how scripts behave:

OptionDescription
NameSpecifies the name of the script as it appears in the Script Kit interface.
DescriptionProvides a brief description of the script's functionality.
ShortcutDefines a global keyboard shortcut to trigger the script.
SnippetDesignates the script as a text expansion snippet and specifies the trigger text.
KeywordAssociates a keyword with the script for easier discovery in the main menu.
PassIndicates that user input in the main menu should be passed as an argument to the script.
GroupAssigns the script to a specific group for organization in the main menu.
ExcludeExcludes the script from appearing in the main menu.
WatchSpecifies a file or directory to watch for changes, triggering the script upon modifications.
BackgroundDesignates the script as a background process, running continuously in the background.
SystemAssociates the script with system events such as sleep, wake, or shutdown.
ScheduleSpecifies a cron expression for scheduling the script to run at specific times or intervals.