@linktwin/cli

The linktwin command-line tool — create, edit and manage your LinkTwin short links, deep links, collections, domains, pixels, QR codes and analytics from your terminal or scripts.

Install

npm install -g @linktwin/cli

Quick start

linktwin login                       # save your API key (or pass --key / --url)
linktwin whoami                      # show account, plan and usage

linktwin links create https://example.com --custom spring-sale
linktwin links list --search sale --order clicks_desc --limit 20
linktwin links get spring-sale
linktwin links update spring-sale --expiry "2025-12-31 23:59:59"
linktwin links delete spring-sale --yes

Get your API key from the LinkTwin Settings page (/user/settings).

Commands

• login / logout / whoami / config
• links — create, list, get, update, delete, bulk-delete
• stats — link, dashboard, detailed, trend
• collections — list, get, create, update, assign, delete
• domains — list, add, update, delete
• pixels — list, get, create, update, assign, delete
• qr — list, get, create, update, delete

Run linktwin <command> --help for details on any command.

Global options

| Flag | Description | | --- | --- | | --json | Output raw JSON instead of formatted tables (ideal for scripting / jq) | | --api-key <key> | Override the saved/env API key | | --base-url <url> | Override the base URL (self-hosted / custom domains) |

Advanced link fields

Targeting and other structured fields can be passed as raw JSON via --data, which is merged into the request body:

linktwin links create https://example.com --custom promo \
  --data '{"geotarget":[{"location":"Canada","link":"https://example.ca"}],
           "parameters":[{"name":"utm_source","value":"newsletter"}]}'

Credential precedence

Flags → environment (LINKTWIN_API_KEY, LINKTWIN_BASE_URL) → saved config (~/.linktwin/config.json, mode 0600) → default base URL https://linktw.in.

License

MIT