cxa-track

:memo: cxa-track

Convenient CLI to quickly create or update CxA tracked links.

Features:

• Watch mode to automagically catch URLs from clipboard and update them without intervention
• Batch mode to search & replace tracked URLs directly in text files
• Front matter support, using trackingCode, tracking_code or tracking-code property if it's defined

Installation

npm install -g cxa-track

CLI Usage

Usage: cxa [options] [<files|URL>]

You can omit the URL argument if you copy one to the clipboard.

Options:
  -s, --set <tracking-code>    Set default tracking code
  -t, --track <tracking-code>  Use specified tracking code
  -w, --watch                  Watch clipboard for URLs
  -k, --keep-locale            Keep locale code in URLs
  -l, --locale <locale-code>   Force locale code in URLs
  -e, --extra                  Extra query params to update
  -h, --help                   Show this help

Tracking code format (fallback to default for missing values):
  ID
  area-ID
  area-ID-alias

Locale format: <language>-<country>, example: en-us
Extra format: <param1>=<value1>&<param2>=<value2>, example: foo=bar&baz=qux

Default tracking code

You should run cxa -s area-ID-alias at least once to save your default tracking code.

You will then be able to override it partially or fully using the -t options when needed.

Watch mode

When using cxa -w the app will be left open and monitor your clipboard: each time tracked URLs are detected, they will be updated directly in the clipboard so you can just paste them.

Note that it work with both single URLs and any text containing multiple URLs 😎.

Batch mode

Using cxa <files> you can update tracked links in a bunch of text files at once. Only URLs matching tracked domains will be affected, you can see the list here.

Using the trackingCode property in a Front matter section of your files, you can use different tracking code per file (partial overrides are supported, like with -t option). This property will always have the priority over the -t option.

Note that text files are read and written using UTF-8 encoding, be careful if you use other encodings!

Changelog

2.0.0 (2022-08-22)

Bug Fixes

• avoid crashing on invalid front matter in watch mode (3d38dd6)
• devblogs as tracked domain (626aeba)

Features

• add --extra option (2506cfd)
• update packages and migrate to ESM (21c64ba)

BREAKING CHANGES

• • Package is now ESM-only

• Requires Node 14+