Install and sign in

Install the Paysum CLI and sign in with a store API key.

Requirements #

Node.js 20 or newer on macOS, Linux or Windows. The CLI has no other dependencies.

Install #

npm install --global @paysum/cli

Check it worked with paysum --version.

Create a key #

Open API keys

In the dashboard go to Developers → API keys and choose New key.

Choose scopes

Under Store API, set Theme code to Write and Store details to Read. That is all the CLI needs.

Copy the key

The key is shown once. Keep it somewhere safe, such as a password manager.

$ paysum login

  Paysum  sign in

  Create a key in Dashboard → Developers → API keys.
  Give it themes:write to push and publish, or store:read to look around.

  API key › ••••••••••••••••••••••••••••
  ✓ Signed in to Acme Keys acme.paysum.io

The key is stored in ~/.config/paysum/credentials.json (%APPDATA%\paysum on Windows), readable only by your user. Sign in to more than one store and the CLI uses the right key for each theme folder automatically. paysum whoami shows which store and scopes are active.

Skip the prompt

Set PAYSUM_API_KEY or pass --key and the CLI uses that key without saving anything. This is how CI works.