How do I install the TrackRev CLI?

Run npm install -g trackrev — or pnpm add -g trackrev, yarn global add trackrev, bun add -g trackrev. That puts a trackrev command on your PATH, so from then on you just type trackrev channels. It needs Node 20 or newer and has zero dependencies, so there is nothing else to install or audit.

What does npx trackrev channels do?

npx runs an npm package without installing it. npx trackrev channels downloads the TrackRev CLI into a temporary cache, runs its channels command once, and leaves nothing on your PATH — handy for a one-off check or a CI step. If you use the CLI regularly, install it globally and type trackrev channels instead.

Where does my API key go?

Nowhere but your shell. The CLI reads TRACKREV_KEY from the environment, sends it as a Bearer token over HTTPS to app.trackrev.io, and never writes it to disk. Create a secret key under Settings → Developers, and revoke it there the moment you no longer need it.

Can I create links from the CLI?

Not yet — today the CLI is read-only: channels, links, clicks, and journey. Link creation lives in the dashboard and the bulk CSV importer. Tell us what you'd script first and we'll prioritise it.

Does it work on Windows?

Yes — anywhere Node 20 or newer runs. In PowerShell set the key with $env:TRACKREV_KEY = "lk_live_…" instead of export. Table, TSV, and JSON output behave identically.

Why is the conversions column a decimal?

Because attribution splits credit. Under a linear model, one sale touched by two channels counts 0.5 on each, so the column sums correctly across the table instead of double-counting the sale.

Can I use it against staging or a self-hosted TrackRev?

Yes. Set TRACKREV_API_URL to any API base — for example https://staging.example.com/api/v1 — and every command talks to that host instead of app.trackrev.io.

TrackRev CLI

Your link analytics, in the terminal.

Create tracking links, then pull channels, links, the raw click stream and any visitor's full journey — the same numbers as the dashboard, without leaving your shell. An aligned table when you're reading, tab-separated values when you pipe, and the API's own JSON for jq.

Get your API key See the commands

$ npm install -g trackrev

Puts the trackrev command on your PATH. Node 20 or newer.

Zero dependencies
Node 20+
MIT licensed

trackrev — zsh

➜ ~ trackrev channels --days 7 --ltv

channel clicks visitors conversions revenue ltv

youtube 1,204 980 12.50 2,410.50 9,180.00

newsletter 310 287 9.00 1,890.00 7,240.00

affiliates 512 461 6.00 1,164.00 4,020.00

twitter 891 640 2.50 318.50 610.00

direct 144 131 1.00 129.00 129.00

➜ ~

exit 0Pipe it and you get TSV. Add --json for jq.

Dependencies

Commands

Output modes — table, TSV, JSON

10 s

From install to your first table

Install

One install, one environment variable.

Install it once with npm, create a secret key under Settings → Developers, and export it. From then on every command is just trackrev — no flags to remember, no config file, no login flow, no daemon. The CLI is a single file that talks to the Analytics API over HTTPS with the key you give it.

npm install -g trackrev puts a trackrev command on your PATH
Or skip the install: npx trackrev <command> runs it once, then forgets it
TRACKREV_API_URL points it at staging or a self-hosted API

terminal

bash

1# 1. Install the CLI (needs Node 20+)2npm install -g trackrev3 4# 2. Create a secret key under Settings → Developers, then export it5export TRACKREV_KEY=lk_live_…6 7# 3. Run it — from here on, every command starts with "trackrev"8trackrev channels --days 7 --ltv9 10# Don't want to install it? npx runs one command and keeps nothing:11npx trackrev channels

Open Settings → Developers to create a key · package on npm

Command reference

Create links. Read everything.

Each command maps to a single API endpoint, so what you do in the terminal is exactly what the dashboard does — same limits, same windows, same attribution model.

$ trackrev channels --days 7 --ltv

trackrev channelsPaid plan

performance per traffic source

--days N: last N days (default 30, max 365)
--from ISO: explicit start, e.g. 2026-01-01; wins over --days
--to ISO: explicit end (defaults to now)
--ltv: add all-time lifetime value per channel

conversions is a decimal on purpose — attribution splits credit, so one sale touched by two channels counts 0.5 on each.

$ trackrev links perf --limit 20

trackrev links perfPaid plan

performance per short link (bare `trackrev links` still works)

--limit N: rows to return (max 500)
--days N: last N days (default 30, max 365)
--from ISO: explicit start, e.g. 2026-01-01; wins over --days
--to ISO: explicit end (defaults to now)
--settings: attach each link's URL, expiry and password flag

$ trackrev clicks --all --json

trackrev clicksPaid plan

the raw click stream — newest first, bots excluded

--limit N: page size (default 100, max 500)
--all: follow the cursor to the end of the stream
--link ID: one link only
--bots: include bot traffic

--all stops after 200 pages and says so on stderr, so a runaway cursor can never loop forever.

$ trackrev journey <visitor-id>

trackrev visitors journeyPaid plan

one visitor's timeline — every click, identify event and order, in order

The visitor caption goes to stderr, so the rows stay pipe-clean.

$ trackrev links list --channel youtube

trackrev links list

the links themselves — newest first, no window

--limit N: page size (default 100, max 500)
--all: follow the cursor to the end
--channel KEY: one channel only
--q TEXT: slug contains this text

$ trackrev links create --url https://acme.com/launch --name Launch --channel youtube --channel newsletter

trackrev links create

create a campaign: one link per channel, or one Smart Link

--url URL: destination (required)
--name TEXT: campaign name (required)
--channel KEY: a channel; repeat for several
--smart: one link that infers its channel per click
--tag TEXT: a tag; repeat for several
--folder ID: put the campaign in this folder
--external: destination is a site you can't put the pixel on
--slug SLUG: custom slug (2–64 chars; lowercase, digits, hyphens)
--campaign TEXT: utm_campaign (defaults to the name)
--expires ISO: expire at this time
--max-clicks N: expire after this many clicks
--expired-url URL: where to send visitors after expiry
--password TEXT: require this password before redirecting
--mobile-url URL: device targeting: send mobile here
--desktop-url URL: device targeting: send desktop here
--retarget on|off: fire the workspace's ad pixels on click

Prints one row per link created. Channels: facebook instagram youtube linkedin twitter tiktok newsletter website other.

$ trackrev links get black-friday

trackrev links get

one link by id, slug or short code

$ trackrev links update <id> --expires 2026-12-31T23:59:59Z --max-clicks 1000

trackrev links update

change a link's slug, UTMs, expiry, password or targeting

--term TEXT: utm_term
--content TEXT: utm_content
--clear-password: remove the password
--clear-expiry: remove date and click-cap expiry
--slug SLUG: custom slug (2–64 chars; lowercase, digits, hyphens)
--campaign TEXT: utm_campaign (defaults to the name)
--expires ISO: expire at this time
--max-clicks N: expire after this many clicks
--expired-url URL: where to send visitors after expiry
--password TEXT: require this password before redirecting
--mobile-url URL: device targeting: send mobile here
--desktop-url URL: device targeting: send desktop here
--retarget on|off: fire the workspace's ad pixels on click

$ trackrev links delete <id> --yes

trackrev links delete

delete one link (its campaign and other channels stay)

$ trackrev links bulk --file links.csv

trackrev links bulk

create up to 500 links from a CSV

--file PATH: CSV with url, name, channel columns (- for stdin)

Optional columns: utm_campaign, utm_term, utm_content, tags, campaign_id. Rows that fail are listed with the reason; the rest are created.

$ trackrev links qr black-friday --out black-friday.svg

trackrev links qr

the link's QR code as SVG

--out PATH: write here instead of stdout
--size N: size in px (default 512, max 2048)

$ trackrev me

trackrev me

which workspace, plan, limits and key you're using

$ trackrev login --profile staging --api-url https://staging.example.com/api/v1

trackrev login

save a secret key so you don't need TRACKREV_KEY

--key lk_…: the key (prompted, hidden, when omitted)
--api-url URL: API base for this profile

Stored at ~/.config/trackrev/config.json with mode 0600. TRACKREV_KEY in the environment always wins, for CI.

$ trackrev logout

trackrev logout

forget a saved key

Every flag, in full, in the CLI reference

Three ways out

Reads like a table. Pipes like data.

The same command adapts to where its output is going. On a terminal you get an aligned, comma-formatted table. Into a pipe or a file you get tab-separated raw values — 2410.5, not 2,410.50 — so cut, awk, and sort see real numbers. Add --json and you get the API's own body, untouched, for jq.

TTY detection — no --format flag to remember
Piped output is raw on purpose: spreadsheets and scripts get numbers
--json is the API response verbatim, so the docs are the schema

$ trackrev channelson a terminal

channel     clicks   revenue
youtube      1,204  2,410.50
newsletter     310  1,890.00

$ trackrev channels > channels.tsvinto a pipe or file

channel → clicks → revenue
youtube → 1204 → 2410.5
newsletter → 310 → 1890

$ trackrev channels --json | jq .with --json

{ "channels": [
  { "channel": "youtube", "clicks": 1204, "revenue": 2410.5 },
  { "channel": "newsletter", "clicks": 310, "revenue": 1890 }
] }

Built for pipes

Compose it with the tools you already have.

Because stdout only ever carries data, every command slots into a shell pipeline. Filter the click stream with jq, rank links with sort, diff two windows, or feed a visitor id from clicks straight into journey with xargs. Cron it and you have a nightly export with no dashboard login.

Cursor pagination handled for you — --all walks the whole stream
Bots excluded by default; --bots when you want the noise
ISO timestamps and UUIDs, ready for a warehouse load

pipelines

bash

1# Top five links by revenue, this month2trackrev links --limit 100 \3  | tail -n +2 | sort -t$'\t' -k6,6nr | head -54 5# Every click from one country, as JSON6trackrev clicks --all --json \7  | jq '.clicks[] | select(.country == "BD")'8 9# Newest visitor → their whole journey10trackrev clicks --limit 1 | tail -1 | cut -f6 \11  | xargs trackrev journey

Unix-honest

stderr for humans, stdout for machines.

Warnings, errors, and the journey caption go to stderr — never into your pipe. Exit codes distinguish a usage mistake from a failed request, so a cron job can tell the difference between a typo and an expired key. And --all caps itself at 200 pages and says so, rather than looping on a bad cursor.

0 success · 1 runtime failure · 2 usage error
401, 402, and 404 each get a one-line message that says what to do
No stack traces — an unknown flag is a one-line usage error

Exit codes

0Success
1No API key · auth failure · network or API error · not found
2Usage error — unknown flag or command, bad value, missing argument
3Plan required — this command needs a paid plan

$ trackrev journey 3f1b8c22-… 2>/dev/null | wc -l

# the visitor caption went to stderr — only rows reached wc

Recipes

Copy, paste, done.

One-liners for the questions teams actually ask. Each one is a complete command — swap the window or the filter and run it.

One link per channel for a launch, printing just the URLs

bash

trackrev links create --url https://acme.com/launch --name Launch \
  --channel youtube --channel newsletter | cut -f3

A link that dies after 1,000 clicks

bash

trackrev links create --url https://acme.com/beta --name Beta --channel newsletter \
  --max-clicks 1000 --expired-url https://acme.com/waitlist

Import a quarter of links from a spreadsheet export

bash

trackrev links bulk --file q4-links.csv

Just the revenue column

bash

trackrev channels --days 7 | cut -f1,5

Frequently asked

What developers ask before wiring the CLI into a script — cost, install, where the key goes, and what it can't do yet.

The CLI itself is free and open source (MIT) on npm. Link and account commands — creating, listing and editing links, and trackrev me — work on every plan, including free, and respect the same limits as the dashboard. The analytics commands (channels, links perf, clicks, journey) are included on every paid plan; on a free workspace they exit 3 with a clear upgrade message instead of empty data.

Go deeper

Compare TrackRev vs Bitly, Rewardful & 12 more →

npm install -g trackrev

Install it, create a secret key, export it — then trackrev channels is the whole workflow. The CLI is free and open source; the Analytics API it reads from is included on every paid plan.

Start free Read the CLI docs

MIT licensed · Zero dependencies · Node 20+

Your link analytics, in the terminal.

One install, one environment variable.

Create links. Read everything.

trackrev channelsPaid plan

trackrev links perfPaid plan

trackrev clicksPaid plan

trackrev visitors journeyPaid plan

trackrev links list

trackrev links create

trackrev links get

trackrev links update

trackrev links delete

trackrev links bulk

trackrev links qr

trackrev me

trackrev login

trackrev logout

Reads like a table. Pipes like data.

Compose it with the tools you already have.

stderr for humans, stdout for machines.

Copy, paste, done.

Frequently asked

Pairs well with

Channel Analytics

Visitor Journey Timeline

Analytics Breakdown

npm install -g trackrev

Your link analytics, in the terminal.

Install and authenticate

One install, one environment variable.

Create links. Read everything.

trackrev channelsPaid plan

trackrev links perfPaid plan

trackrev clicksPaid plan

trackrev visitors journeyPaid plan

trackrev links list

trackrev links create

trackrev links get

trackrev links update

trackrev links delete

trackrev links bulk

trackrev links qr

trackrev me

trackrev login

trackrev logout

Designed for the shell

Reads like a table. Pipes like data.

Compose it with the tools you already have.

stderr for humans, stdout for machines.

Copy, paste, done.

Frequently asked

Is the TrackRev CLI free?

How do I install the TrackRev CLI?

What does npx trackrev channels do?

Where does my API key go?

Can I create links from the CLI?

Does it work on Windows?

Why is the conversions column a decimal?

Can I use it against staging or a self-hosted TrackRev?

Pairs well with

Channel Analytics

Visitor Journey Timeline

Analytics Breakdown

npm install -g trackrev