@rerout/cli
v0.2.0
Published
Command-line interface for Rerout — branded short links, QR codes, and analytics from your terminal.
Downloads
282
Maintainers
Readme
@rerout/cli
Branded short links, QR codes, and analytics from your terminal — a thin CLI over
@rerout/sdk.
npm install -g @rerout/cliAuthenticate
Mint a project API key in the dashboard (Owner/Admin), then:
rerout login --api-key rrk_...The key is verified against the API and stored at
$XDG_CONFIG_HOME/rerout/config.json (default ~/.config/rerout/config.json)
with 0600 permissions. Alternatively set REROUT_API_KEY in the environment
(it takes precedence over the saved key). Use --base-url / REROUT_BASE_URL
for staging or self-hosted APIs.
Commands
rerout whoami # show the key's project
rerout create https://example.com/sale \ # create a link
--domain go.brand.com --code sale
rerout ls --limit 20 # list links
rerout get sale # show one link
rerout update sale --inactive # patch a link
rerout rm sale # soft-delete a link
rerout stats # project stats (--days 30)
rerout stats sale --days 7 # per-link stats
rerout qr sale # print the QR URL
rerout qr sale --output sale.svg # write the QR SVG
rerout webhooks ls
rerout webhooks create --name "Orders" --url https://example.com/hook \
--events link.created,link.clicked
rerout webhooks rm wh_...
rerout tags ls # tags with link counts
rerout tags create "Spring 2026" --color teal
rerout tags update tag_... --name "Spring '26"
rerout tags rm tag_...Add --json to any command for raw, machine-readable output.
Development
npm install
npm run typecheck
npm test # vitest — network is stubbed via an injected fetch
npm run build # emits dist/ (CLI bin + ./core)The reusable pieces (config, client factory, formatting) are exported from
@rerout/cli/core so other surfaces — like the planned Raycast extension — can
share one engine instead of re-implementing auth and rendering.
Publishing
npm run build
npm publish --access public