Ikawaari CLI (ikw)

The Ikawaari CLI lets you interact with the Ikawaari API directly from your terminal. Create payments, manage webhooks, trigger sandbox events, and more — all without leaving your shell.

Installation

npm

npm install -g @ikawaari/ikw

Standalone binary

Download the latest release for your platform from the releases page:

# Linux / macOS
curl -L https://releases.ikawaari.com/ikw/latest/ikw-linux-x64 -o /usr/local/bin/ikw
chmod +x /usr/local/bin/ikw

# Windows (PowerShell)
Invoke-WebRequest -Uri https://releases.ikawaari.com/ikw/latest/ikw-win-x64.exe -OutFile ikw.exe

From source

git clone https://github.com/daoudabeye/IkawaariPaaS.git
cd IkawaariPaaS/apps/ikw
npm install
npm run build
npm link

Verify the installation:

ikw --help

Quick Start

# 1. Authenticate with your API key
ikw auth login:manual --api-key ik_test_your_key_here

# 2. Create a payment
ikw payments create --amount 5000 --currency XOF

# 3. List recent payments
ikw payments list --limit 5

# 4. Listen for webhooks locally
ikw webhooks listen --port 4242

Global Options

Every command supports these flags:

Flag	Description
--json	Machine-readable JSON output (ideal for scripting)
--dry-run	Print the API request without executing it
--debug	Enable debug logs
--trace	Print full API request/response details (redacted)
--request-id	Print the Ikawaari-Request-Id response header
--idempotency-key <key>	Set Idempotency-Key header for mutating requests

JSON output

All commands support --json for machine-readable output, making it easy to pipe into jq or other tools:

ikw payments list --limit 3 --json | jq '.data[].id'

Dry run

Preview the API request without sending it:

ikw payments create --amount 5000 --currency XOF --dry-run

Command Groups

Command	Description
auth	Authentication and credentials
config	CLI configuration (projects, environments)
payments	Create, list, inspect, confirm, cancel, refund payments
customers	Manage customers
webhooks	Manage webhook endpoints + local listener
payouts	Create and manage payouts
invoices	Create and manage invoices
subscriptions	Manage subscriptions
products	Manage products and prices
sandbox	Trigger sandbox test events
events	List and inspect events
balances	View account balances
api-keys	Manage API keys
checkout	Manage checkout sessions
payment-links	Manage payment links
radar	Radar fraud detection
reporting	Reports and exports
team	Team management
settings	Merchant settings
compliance	Compliance and KYC
ops	Operator / admin commands
health	Platform health checks

Next Steps

• Authentication — Set up credentials
• Configuration — Projects and environments
• Webhooks — Local webhook listener
• Sandbox — Trigger test events
• Full Command Reference — All commands