Skip to content

CLI

Paycux CLI

How Paycux CLI works in Paycux, what it is for, and the smallest setup that gets it running.

Companion tools

Companion tools is handled by Paycux CLI rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Paycux Migrations

Migrations run alongside your current system rather than replacing it in one step. Import the accounts you already have, run both paths in parallel, then cut over once the numbers agree.

  1. 1Export your existing users with their stable identifiers and email addresses.
  2. 2Import them into Paycux; imported users keep their original ID under external_id so your foreign keys stay valid.
  3. 3Send new sign-ins through Paycux while old sessions continue to work.
  4. 4Retire the old path once sign-in volume through Paycux matches your baseline.

Paycux Emulate

Paycux Emulate is handled by Paycux CLI rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

paycux

paycux is handled by Paycux CLI rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Installation

Install the SDK with your package manager, then read the API key from the environment rather than hard-coding it.

1npm install @paycux/node

Features

Features is handled by Paycux CLI rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

What It Creates

What It Creates is handled by Paycux CLI rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Credentials

Credentials is handled by Paycux CLI rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.