Disclaimer: These legal policy links are provided for convenience only, links may change over time and as a solo developer, I can't guarantee every link stays up to date.

• Self-Hosted & Custom Domains: Use the full URL and set the --domain flag when using yourls or custom providers.
• Custom Config: Sent in key: value format.
• Config Parameters: auth_param specifies key requirements; url_param sets the request payload variable (defaults to "url").
• NO_COLOR: We support the NO_COLOR initiative. Add NO_COLOR=1 to os.environ to disable output styling
• FORCE_COLOR: Add FORCE_COLOR=1 to your env variables to force color for use in asciinema or vhs recordings.
• Pipes: We support piping data, when piping bare is automatically appiled ensuring no color and only url is sent allowing for more complex piping.
• Proxying: SOCKS proxies and TOR routing is fully supported if you install the required add-on for requests, simply add your socks proxy URL to the proxy list.

These common tracking parameters are automatically stripped when shortening.

    # Standard UTM Parameters
    "utm_source", "utm_medium", "utm_campaign", "utm_term",
    "utm_content", "utm_id", "utm_source_platform",

    # Ad Network & Click Identifiers
    "gclid", "gclsrc", "fbclid", "msclkid", "ttclid",
    "twclid", "dclid", "li_fat_id", "yclid",

    # Platform & Social Sharing Trackers
    "igshid", "s", "t", "si", "feature", "app",
    "ref", "ref_src", "ref_url",

    # Email & Marketing Automation (CRMs)
    "mc_eid", "mc_cid", "_hsenc", "_hsmi", "mkt_tok",
    "klaviyo_id", "_kx", "vero_id",

    # E-Commerce & Affiliate Trackers
    "tag", "ascsubtag", "ref_", "itm_source", "itm_medium",
    "affiliate_id", "aff_id",

Adding httpbin as a service example

"httpbin": {
    "serviceurl": "https://httpbin.org/post",
    "method": "POST",
    "url_param": "destination",
    "slug_param": "key",
    "params": {}
}

Testing httpbin example

cshorten shorten https://example.com -s httpbin -k ApiKey

No Key Service JSON Example 🔓

"0x0": {
        "serviceurl": "https://0x0.st",
        "method": "POST",
        "multifile": true,
        "url_param": "shorten",
        "json_body": false,
        "params": {}
     },

Testing 0x0 example

cshorten shorten https://example.com -s 0x0

Authenticated API JSON Example 🔐

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