Skip to Content
Developer Portal preview — pages marked Draft describe the intended design and are not yet available.
Go to Syper Console

CLI

Manage Syper from your terminal.

DraftDescribes the intended design. Not yet available — names, fields and behaviour may change.

The Syper CLI is designed for day-to-day development and automation: authenticating, switching environments, calling the API, and testing webhooks.

The CLI has not been published. Command names below show the intended shape and will change.

Installation

Installation instructions will be added when the CLI is released.

Authentication

The CLI authenticates once and stores credentials in your operating system’s secure credential store — never in plain-text config files committed to source control.

Environments

Every command runs against one environment. The CLI will default to the sandbox and require an explicit flag for production.

Common tasks

TaskDescription
Log inAuthenticate the CLI with your developer account.
Manage keysCreate, list, and revoke API keys.
Call the APISend authenticated requests to any endpoint.
Listen for webhooksForward events to a local server. See Webhook Tester.
Trigger eventsFire sandbox events such as payment.completed.
Tail logsStream request logs.

Automation and CI

In CI, authenticate with a restricted sandbox API key supplied as an environment variable, and use the CLI to seed test data and trigger events in integration tests.

Last updated on