https://github.com/sinedied/cxa-track

:memo: Convenient CLI to quickly update CxA tracked links
https://github.com/sinedied/cxa-track

Last synced: 7 months ago
JSON representation

:memo: Convenient CLI to quickly update CxA tracked links

• Host: GitHub
• URL: https://github.com/sinedied/cxa-track
• Owner: sinedied
• License: mit
• Created: 2019-11-28T10:22:25.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-08-29T15:00:52.000Z (about 2 years ago)
• Last Synced: 2025-03-11T00:16:34.726Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.48 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# :memo: cxa-track

[![NPM version](https://img.shields.io/npm/v/cxa-track.svg)](https://www.npmjs.com/package/cxa-track)

[![Build Status](https://github.com/sinedied/cxa-track/workflows/build/badge.svg)](https://github.com/sinedied/cxa-track/actions)

![Node version](https://img.shields.io/node/v/cxa-track.svg)

[![Install size](https://packagephobia.now.sh/badge?p=cxa-track)](https://packagephobia.now.sh/result?p=cxa-track)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)



> 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](https://jekyllrb.com/docs/front-matter/) support, using `trackingCode`, `tracking_code` or `tracking-code` property if it's defined

## Installation

```sh

npm install -g cxa-track

```

## CLI Usage

```

Usage: cxa [options] []

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

Options:

  -s, --set     Set default tracking code

  -t, --track   Use specified tracking code

  -w, --watch                  Watch clipboard for URLs

  -k, --keep-locale            Keep locale code in URLs

  -l, --locale    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: -, example: en-us

Extra format: =&=, 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 ` 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](https://jekyllrb.com/docs/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!