CLI installation

The Plugipay CLI is a Node.js command-line tool that gives you terminal access to everything the dashboard does — querying payments, managing customers, configuring webhooks, scripting batch operations, and more.

This page covers installing it. Once installed, head to Authentication to sign in.

Requirements

Node.js 18 or later. Check with node --version. If you need to install Node, nodejs.org is the canonical source — pick the LTS build.
npm 9+ (ships with Node).
A working terminal — macOS Terminal, iTerm, Windows Terminal, or any Linux terminal emulator.

The CLI is platform-agnostic. We test on macOS, Linux, and Windows.

Install

The package is published as @forjio/plugipay-cli:

npm install -g @forjio/plugipay-cli

Or with pnpm:

pnpm add -g @forjio/plugipay-cli

Or with yarn:

yarn global add @forjio/plugipay-cli

Verify the install:

plugipay --version

You should see something like 0.1.0.

command not found? Your global npm bin directory isn't on your PATH. Run npm config get prefix — the bin directory is at <prefix>/bin. Add it to your shell's PATH in ~/.zshrc, ~/.bashrc, or equivalent.

Without installing globally

If you'd rather not pollute your global packages, run the CLI via npx:

npx @forjio/plugipay-cli --version

Every command works the same way:

npx @forjio/plugipay-cli customers list
npx @forjio/plugipay-cli checkout create --amount 50000 ...

The downside: each invocation has a small npm-resolution overhead (~1-2 seconds the first time, cached after). For one-offs that's fine. For scripts, install globally.

As a project dependency

For repositories where the CLI is part of the dev workflow (CI scripts, migration tooling), add it as a devDependency:

npm install --save-dev @forjio/plugipay-cli

Then either invoke it via npx plugipay or add a script entry to package.json:

{
  "scripts": {
    "plugipay": "plugipay"
  }
}

Now npm run plugipay -- customers list works.

Updating

Check your current version:

plugipay --version

Check the latest published version:

npm view @forjio/plugipay-cli version

Update:

npm install -g @forjio/plugipay-cli@latest

We recommend updating regularly — new features and bug fixes ship roughly weekly. Breaking changes are batched and announced in advance.

Uninstalling

npm uninstall -g @forjio/plugipay-cli

This removes the binary. Your credentials (in ~/.plugipay/config.json) stay on disk — delete the file manually if you want to wipe them:

rm -rf ~/.plugipay

Shell completion

Tab-completion for command names, subcommands, and options. Generate the script for your shell:

plugipay completion bash >> ~/.bashrc
plugipay completion zsh  >> ~/.zshrc
plugipay completion fish > ~/.config/fish/completions/plugipay.fish

Restart your shell. Now plugipay <tab> lists command groups, plugipay customers <tab> lists subcommands, and plugipay customers create --<tab> lists flags.

Authentication — sign in to your workspace.
Configuration — profiles, env vars, defaults.
Command reference — every group, every subcommand.