# PopClip

> PopClip is a macOS app that shows a menu of actions — copy and paste, web
> search, link opening, translation and many more — when you select text with
> the mouse or trackpad. It is extensible: anyone can create extensions, from
> single-file text snippets to JavaScript packages, and publish them in the
> PopClip Extensions Directory.

Key resources for extension development:

- [Type definitions](https://www.popclip.app/dev/popclip.d.ts): Complete TypeScript definitions for PopClip's JavaScript API and extension config format
- [Developer docs in one file](https://www.popclip.app/dev/all.md): The whole extension developer docs as a single Markdown file
- [All docs in one file](https://www.popclip.app/llms-full.txt): Developer docs, user guide and knowledge base as a single file

The pages below are Markdown twins of the pages at the same URL without the
`.md` suffix.

## Developer Docs

- [Introduction](https://www.popclip.app/dev/index.md): Entry point to the extension developer docs: concepts, resources and how to get help
- [Snippets](https://www.popclip.app/dev/snippets.md): Extension snippets — plain-text extensions that install directly from selected text
- [Packages](https://www.popclip.app/dev/packages.md): Extension packages — the .popclipext folder format, its files and installation
- [Config](https://www.popclip.app/dev/config.md): The extension configuration dictionary: formats, top-level properties, options and localization
- [Icons](https://www.popclip.app/dev/icons.md): Icon specifier strings: text icons, modifiers, Iconify icons, SF Symbols, image files and SVG
- [Actions](https://www.popclip.app/dev/actions.md): Properties common to all actions: titles, icons, requirements, before/after steps and submenus
- [Open URL actions](https://www.popclip.app/dev/url-actions.md): Actions that open a URL generated from a template, e.g. web searches
- [Key Press actions](https://www.popclip.app/dev/key-press-actions.md): Actions that simulate a key press with a key combo specifier
- [Service actions](https://www.popclip.app/dev/service-actions.md): Actions that invoke a macOS Service by name
- [Shortcut actions](https://www.popclip.app/dev/shortcut-actions.md): Actions that invoke a macOS Shortcut by name
- [JavaScript actions](https://www.popclip.app/dev/js-actions.md): Actions that run JavaScript code in PopClip's JavaScript environment
- [AppleScript actions](https://www.popclip.app/dev/applescript-actions.md): Actions that run AppleScript code, for automating other apps
- [Shell Script actions](https://www.popclip.app/dev/shell-script-actions.md): Actions that run a shell script in any scripting language, with variables and output handling
- [Script variables](https://www.popclip.app/dev/script-variables.md): The context variables PopClip passes to JavaScript, AppleScript and shell scripts
- [JavaScript environment](https://www.popclip.app/dev/js-environment.md): PopClip's sandboxed JavaScript runtime: globals, modules, network access and utilities
- [Module-based extensions](https://www.popclip.app/dev/js-modules.md): Defining a whole extension in JavaScript or TypeScript with defineExtension()
- [Authentication](https://www.popclip.app/dev/auth.md): Signing in to external services: the auth function, OAuth flows, secret storage and util.clarify
- [Developer Changelog](https://www.popclip.app/dev/changelog.md): Changes to the extensions programming interface, by PopClip version

## User Guide

- [Welcome](https://www.popclip.app/guide/index.md): Introduction to PopClip and answers to frequently asked questions
- [Installation](https://www.popclip.app/guide/install.md): System requirements, editions (Standalone, Mac App Store, Setapp) and how to install
- [Basics](https://www.popclip.app/guide/basics.md): Using the PopClip bar: making it appear and disappear, and controlling when it shows
- [Built-in Actions](https://www.popclip.app/guide/actions.md): The built-in actions: Cut, Copy, Paste, Search, Open Link, Dictionary and more
- [Extensions](https://www.popclip.app/guide/extensions.md): Installing and managing extensions, and extension security
- [Organizing Actions](https://www.popclip.app/guide/organizing.md): Arranging actions with folders and separators, custom names and icons
- [Settings](https://www.popclip.app/guide/settings.md): The status menu and the settings window, tab by tab

## Knowledge Base

- [Mac App Store migration](https://www.popclip.app/kb/mas.md): How to migrate from the Mac App Store edition to the Standalone edition
- [Troubleshooting](https://www.popclip.app/kb/troubleshooting.md): Common problems and solutions, and known issues with specific apps
- [iCloud Sync](https://www.popclip.app/kb/sync.md): Syncing extensions and actions between Macs with iCloud
- [AppleScript interface](https://www.popclip.app/kb/applescript.md): Controlling the PopClip app itself from AppleScript
- [Browser support](https://www.popclip.app/kb/browsers.md): The browsers PopClip knows about and the support level for each
- [Paths and identifiers](https://www.popclip.app/kb/paths.md): File and folder paths and identifiers used by PopClip
- [Technical notes](https://www.popclip.app/kb/notes.md): Assorted technical details, including website exclusion support

## Optional

- [Submit an Extension](https://www.popclip.app/extensions/submit.md): How to submit an extension to the PopClip Extensions Directory, and the acceptance requirements
- [Terms of License](https://www.popclip.app/terms.md): Terms of license for the PopClip app
- [Privacy Policy](https://www.popclip.app/privacy.md): PopClip's privacy policy
- [Support & Feedback](https://www.popclip.app/support.md): How to get help: email support and the PopClip forum