Skip to content

A PopClip extension for shortening URLs with your self-hosted YOURLS instance

License

Notifications You must be signed in to change notification settings

kesslerio/YOURLS-popclip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

YOURLS PopClip Extension

A PopClip extension that lets you quickly shorten URLs using your self-hosted YOURLS instance.

YOURLS PopClip Extension

What is YOURLS?

YOURLS (Your Own URL Shortener) is a free, open-source URL shortening service that you can host on your own server. It provides:

  • Complete control over your short URLs
  • Detailed analytics and click tracking
  • Custom keywords for memorable short links
  • API for integration with other applications

What is PopClip?

PopClip is a macOS utility that appears when you select text. PopClip extensions provide quick access to actions related to the selected text, such as searching, copying, or in this case, shortening URLs.

Installation

  1. Download the latest release from the Releases page
  2. Double-click the .popclipextz file to install it in PopClip
  3. Configure your YOURLS settings in the PopClip preferences

Configuration

After installation, you'll need to configure the extension with your YOURLS information:

  1. Open PopClip preferences
  2. Find the YOURLS extension and click the gear icon
  3. Enter your YOURLS API URL (e.g., https://yourdomain.com/yourls-api.php)
  4. Enter your signature token from your YOURLS admin panel

Usage

  1. Select a URL in any application
  2. When PopClip appears, click the YOURLS icon
  3. The URL will be shortened and copied to your clipboard

The extension automatically:

  • Adds https:// to URLs that don't have a protocol
  • Handles special cases for certain domains to avoid "already shortened" errors

Features

  • Fast and seamless URL shortening
  • Works with any self-hosted YOURLS instance
  • Secure authentication via signature token
  • Provides visual feedback when shortening fails

Requirements

  • PopClip for macOS
  • A self-hosted YOURLS instance with API access

Building from Source

The extension consists of:

  • Config.json: Configuration for PopClip
  • shortlink.png: Icon for the extension
  • yourls.sh: Script that handles the URL shortening logic

To package the extension manually:

cd YOURLS-fresh.popclipext
zip -r ../YOURLS.popclipextz *

License

This project is released under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

Credits

Created by Martin Kessler, 2025

About

A PopClip extension for shortening URLs with your self-hosted YOURLS instance

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages