
title: Markdown Bold # note: actions have a `title`, not a `name` no tabs allowed in YAML!Ī JavaScript example, including multiple actions: # popclip js + multi action example

# the above lines are indented with two spaces. Macos version: '12.0' # shortcuts only work on Monterey and above!Īn AppleScript example, running a shell script: # popclip shellscript nested in an applescriptĪpplescript: do shell script "say ''"Ī multi-line AppleScript example (the pipe character begins a YAML multi-line string, and the following lines must all be indented with two spaces - not tabs!): # PopClip LaunchBar exampleĪpplescript: | # pipe character begins a multi-line string Icon: symbol:moon.stars # Apple SF Symbols Extension Snippets ExamplesĪ Shortcuts example: # popclip shortcuts example Installing another extension with the same name (or identifier) will overwrite an existing one. In the absence of an explicit identifier field, the extension is identified by its name. AppleScript snippets, and JavaScript snippets with the network entitlement, will still give the unsigned warning.įull Shell Script extensions can't be expressed as snippets, although you can use an AppleScript to run a simple shell script as a string literal (see example below).
POPCLIP EXTENSIONS INSTALL
If the extension is of type Shortcut, Service, URL, Key Combo or JavaScript (without network entitlement), the extension snippet will install without the usual "unsigned extension" prompt. Extension snippets can be a maximum of 1000 characters. The format of a snippet is a simply a regular PopClip extension config in YAML format, with the addition of a comment header beginning with # popclip (with or without a space, not case sensitive).Īll features of regular extensions can be used, with the limitation that additional files (such as icon files or scripts) cannot be included. Clicking it will install the above extension directly, without any need for config files or a. When you select the above text, PopClip will offer an "Install Extension" action. Here is an example extension snippet: # popclip extension to search Emojipedia PopClip 2021.11 supports a new, simplified way to create and share simple extensions called "Extension Snippets". To enable it, run this command in Terminal, then Quit and restart PopClip: defaults write EnableExtensionDebug -bool YES To help you when creating extensions, PopClip can be configured to write script output and debug info to be viewed with the Console app. When basing your own extension off such an extension, you will need to change the identifier.) Debug Output

prefix, which is reserved for 'official' extensions. (PopClip will never load unsigned extensions whose identifier has a com.pilotmoon. Be careful about the extensions you create, and be wary about loading extensions you get from someone else. Please be aware that PopClip extensions can contain arbitrary executable code. Run the following command at the Terminal, then Quit and restart PopClip: defaults write LoadUnsignedExtensions -bool YES If you find this gets annoying while you are testing your work, you can turn off the warning. Extension Signingīy default, PopClip will display a warning dialog when you try to install your own extension, because it is not digitally signed. I may make changes to any extension submitted.Ī good place to tell PopClip users about your work is the Show and Tell section in the PopClip forum.Submitting an extension does not guarantee publication on the website.By contributing to this repo, you agree that your contribution may be published at PopClip Extensions.popclipext folder inside the source-contrib folder.

POPCLIP EXTENSIONS LICENSE
LicenseĪll extension source files are published under the MIT License (see LICENSE.txt) unless noted otherwise in the readme files of individual extensions. This repository contains the documentation for making your own extensions (this readme file) as well as the source files for the extensions published on the official PopClip Extensions page. PopClip Extensions add extra actions to PopClip.
