Clksy CLI

Create tracked short links, check analytics, and manage your workspace — all from your terminal.

Install

npm install -g clksy-cli

Login

clksy login

Opens your browser, you approve, done. Works on all plans. Your token is saved to ~/.clksy/config.json.

clksy logout   # remove saved credentials

Prefer a manual API key? Run clksy auth YOUR_API_KEY instead. API keys require Starter or Pro plan — get one at clksy.co/settings.

Commands

Create a short link

clksy create https://mysite.com
clksy create https://mysite.com --channel twitter
clksy create https://mysite.com --channel newsletter --desc "June digest CTA"

The short URL is automatically copied to your clipboard.

A/B split test

clksy create https://mysite.com/v1 --ab https://mysite.com/v2 --channel twitter

Splits traffic 50/50 between two destinations. Requires Pro plan.

Deeplink

clksy create https://mysite.com --deeplink \
  --ios https://apps.apple.com/yourapp \
  --android https://play.google.com/yourapp

Routes mobile users to the native app, desktop to the fallback URL. Requires Starter+.

List recent links

clksy list

Check stats for a link

clksy stats <short-code>

Workspace analytics

clksy analytics
clksy analytics --days 30
clksy analytics --days 90

Update a link

clksy update <short-code> --url https://newdestination.com
clksy update <short-code> --channel newsletter
clksy update <short-code> --desc "new description"

Other commands

clksy copy <short-code>       # copy short URL to clipboard
clksy open <short-code>       # open in browser
clksy delete <short-code>     # delete (prompts for confirmation)
clksy conversions             # recent conversions
clksy conversions --days 7
clksy workspace               # workspace info and plan
clksy groups                  # list link groups
clksy domains                 # list custom domains

Full reference

| Command | Description | |---|---| | clksy login | Log in via browser (all plans) | | clksy logout | Remove saved credentials | | clksy auth <key> | Save an API key directly (Starter+) | | clksy create <url> | Create a short link | | clksy create <url> --channel <tag> | Create with channel tag | | clksy create <url> --ab <url-b> | A/B split test — Pro | | clksy create <url> --deeplink | Deeplink with --ios / --android — Starter+ | | clksy list | List 10 most recent links | | clksy stats <short-code> | Per-link click stats | | clksy update <short-code> | Update destination, channel, or desc | | clksy copy <short-code> | Copy short URL to clipboard | | clksy open <short-code> | Open short link in browser | | clksy delete <short-code> | Delete a link (prompts for confirmation) | | clksy analytics --days 7\|30\|90 | Workspace-level analytics | | clksy conversions --days 30 | Recent conversions with labels and values | | clksy workspace | Show workspace name, plan and slug | | clksy groups | List link groups | | clksy domains | List custom domains |

Example output

$ clksy create https://mysite.com --channel twitter

✓ Link created — copied to clipboard

  Short URL:    https://r.clksy.co/abc123
  Channel:      twitter
  Destination:  https://mysite.com

$ clksy analytics --days 7

  Analytics — last 7 days

  Total clicks:   127
  Unique clicks:  94

  Top links:
  aXDBwQh              11 clicks  https://clksy.co
  MCLoD56               9 clicks  https://clksy.co

  Channels:
  twitter              43 clicks
  newsletter           38 clicks
  direct               46 clicks

  Top countries:
  IN                   72
  US                   31

  Devices:
  mobile               89 clicks
  desktop              38 clicks

Requirements

Node.js 18+.