@swft-checkout/cli

Command-line interface for Swft Checkout. Manage analytics, sessions, webhooks, and agency merchants without opening a browser.

Installation

npm install -g @swft-checkout/cli

Or run without installing:

npx @swft-checkout/cli <command>

Authentication

swft login sk_live_your_api_key_here

Your API key is saved to ~/.swft/config.json. To use a self-hosted or staging API:

swft login sk_live_your_api_key_here --api-url https://api.staging.swft.co.uk

Check who you're logged in as:

swft whoami

Commands

Analytics

View conversion rates, session counts, and order data.

# Last 30 days (default)
swft analytics

# Aliases
swft stats

# Custom range
swft analytics --range 7d
swft analytics --range 90d

# Include billing and fee breakdown
swft analytics --billing
swft analytics --range 7d --billing

Output includes:

• Sessions started, completed, abandoned
• Conversion rate vs. 2.5% industry average
• Billing: GMV, Swft fees (2%), net revenue, avg order value
• Abandoned cart recovery email performance (30-min, 24-hr, 72-hr)
• Last 5 orders (customer emails partially masked)

Sessions

# List last 20 sessions
swft sessions list

# Filter by status
swft sessions list --status complete
swft sessions list --status abandoned
swft sessions list --status pending
swft sessions list --status expired

# Show more
swft sessions list --limit 50

Webhooks

# List registered endpoints
swft webhook list

# Register a new endpoint (all events by default)
swft webhook add https://yourstore.com/api/swft/webhook

# Register for specific events only
swft webhook add https://yourstore.com/api/swft/webhook \
  --events payment_succeeded,payment_failed

# Remove an endpoint
swft webhook delete whk_abc123

Available event types: payment_succeeded, payment_failed, session_expired

When you add a webhook, the signing secret is displayed once. Store it as an environment variable:

export SWFT_WEBHOOK_SECRET=whsec_...

Merchants (Agency accounts)

Agency accounts can manage multiple merchant stores.

swft merchants list

Output includes Stripe onboarding status, 30-day session counts, and conversion rates per store.

Configuration

Config is stored at ~/.swft/config.json:

{
  "apiKey": "sk_live_...",
  "apiUrl": "https://api.swft.co.uk"
}

To switch accounts, run swft login again with a different key.

Event Types

The SwftWebhookPayload includes these event types:

| Event | Description | |---|---| | payment_succeeded | Customer completed checkout and payment captured | | payment_failed | Payment attempt failed | | session_expired | Checkout session expired without completion |

Help

swft --help
swft analytics --help
swft sessions --help
swft webhook --help
swft merchants --help