Clishortener

A lightweight, feature-rich CLI tool to shorten links using 12+ services—with zero configuration required.

Key Features

• 🚀 Lightweight & Fast: Works right out of the terminal.
• 🔌 12+ Services Pre-configured: TinyURL, Bitly, Short.io, CleanURI, and more.
• 🛠️ Custom & Self-Hosted: Full support for custom domains and YOURLS instances.
• 🎨 Rich Output: Optional colorful terminal UI using rich.
• ⚡ Pipeline Friendly: Pass raw output directly to stdout or other scripts using bare/silent flags.
• 🕹 Plug & Play Start shortening immediately after installation, no setup required.

Installation

Install using pip

pip install clishortener[rich]

Or Install from source using git

git clone https://github.com/Ruizennis/Clishortener
cd Clishortener
pip install .

Optional Packages

• rich

Things Enhanced With rich Installed:

• Available Services menu
• Change default service menu
• Link Output
• Error messages

Quick Start 🚀

Shorten your first url ✂️

cshorten https://example.com

Set your preferred service as the default 🔧

# See All Services list for Identifiers!
cshorten -d dagd

All Services 🌐

Note: As Of 2026-08-01 The Public 0x0.st Instance Is Temporarily Paused With No ETA For Its Return, Self Hosting is recomended. Self-host The Null Pointer (0x0) From https://git.0x0.st/mia/0x0

Flags 🚩

Additional Information 📜

• Default URL shortening service is tinyurl (no key / anonymous)
• Identifier is used when specifying a specific link shortening service with -s or -d
• YOURLS is self-hosted only
• Custom & YOURLS allows any URL to be used
• When using Custom or YOURLS use the full URL
• Commands considered "advanced" are uppercase (-A -U -D -S -H)
• auth_param is used when determining if a service requires an api key
• url_param is what variable is used when sending a request (Default: "url")
• Custom headers should be sent in a key, value format
• --domain allows any URL to be used

Adding Additional Services 🔨

Additional Services Can Be Added By Editing Services.json And Adding New Entries.

Anonymous Service Example (da.gd)

"dagd": {
        "serviceurl": "https://da.gd/s",
        "method": "GET",
        "params": {
            "url": ""
        }
    }

Authenticated API Example (short.io)

"shortio": {
        "serviceurl": "https://api.short.io/links/public",
        "auth_header": "authorization",
        "url_param": "originalURL",
        "method": "POST",
        "json_key": "shortURL",
        "json_body": true,
        "params": {}
}

Additional Links & Credits

Pypi - clishortener Github - Clishorteners Issues - Clishorteners

Credits To Pyshorteners Made By ellisonleao For Inspiring This Tool Pyshorteners

License

This project is licensed under the MIT license, see LICENSE.