CLI Ikawaari (ikw)

Le CLI Ikawaari vous permet d’interagir directement avec l’API Ikawaari depuis votre terminal. Créez des paiements, gérez les webhooks, déclenchez des événements sandbox, et plus encore — sans quitter votre shell.

Installation

npm

npm install -g @ikawaari/ikw

Standalone binary

Téléchargez la dernière release pour votre plateforme depuis la page releases :

# 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

Depuis le code source

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

Vérifiez l’installation :

ikw --help

Démarrage rapide

# 1. S'authentifier avec votre clé API
ikw auth login:manual --api-key ik_test_your_key_here

# 2. Créer un paiement
ikw payments create --amount 5000 --currency XOF

# 3. Lister les paiements récents
ikw payments list --limit 5

# 4. Écouter les webhooks en local
ikw webhooks listen --port 4242

Options globales

Chaque commande prend en charge les flags suivants :

Flag	Description
--json	Sortie JSON lisible par machine (idéale pour le scripting)
--dry-run	Affiche la requête API sans l’exécuter
--debug	Active les logs de debug
--trace	Affiche les détails complets requête/réponse API (caviardés)
--request-id	Affiche l’en-tête de réponse Ikawaari-Request-Id
--idempotency-key <key>	Définit l’en-tête Idempotency-Key pour les requêtes mutantes

Sortie JSON

Toutes les commandes prennent en charge --json pour une sortie lisible par machine, ce qui facilite l’usage avec jq ou d’autres outils :

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

Dry run

Prévisualisez la requête API sans l’envoyer :

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

Groupes de commandes

Commande	Description
auth	Authentification et credentials
config	Configuration CLI (projets, environnements)
payments	Créer, lister, inspecter, confirmer, annuler, rembourser des paiements
customers	Gérer les clients
webhooks	Gérer les endpoints webhook + listener local
payouts	Créer et gérer des payouts
invoices	Créer et gérer des factures
subscriptions	Gérer les abonnements
products	Gérer les produits et les prix
sandbox	Déclencher des événements de test sandbox
events	Lister et inspecter les événements
balances	Voir les balances de compte
api-keys	Gérer les clés API
checkout	Gérer les checkout sessions
payment-links	Gérer les payment links
radar	Détection de fraude Radar
reporting	Rapports et exports
team	Gestion d’équipe
settings	Paramètres marchands
compliance	Compliance et KYC
ops	Commandes opérateur / admin
health	Vérifications de santé plateforme

Étapes suivantes

• Authentification — Configurer les credentials
• Configuration — Projets et environnements
• Webhooks — Listener webhook local
• Sandbox — Déclencher des événements de test
• Référence complète des commandes — Toutes les commandes