ikw (Ikawaari CLI)

ikw est le CLI Node.js d’Ikawaari.

• Exécutable: ikw
• Source: apps/ikw
• Build output: apps/ikw/dist

Objectifs

• Fournir une interface CLI pour interagir avec l’API Ikawaari (merchant/ops)
• Servir de base pour unifier les commandes avec le Workbench du dashboard via apps/cli-sdk

Installation & Build

Depuis apps/ikw:

npm install
npm run build

Lancer:

npm run start
# ou
node dist/index.js

Une fois publie, l'installation publique ciblee est:

npm install -g @ikawaari/ikw

ou sans installation globale:

npx @ikawaari/ikw login

Packaging binaire

npm run package:bin

Commandes

Le CLI expose des commandes organisées par module (ex: payments, products, webhooks, ...).

Exemples:

ikw payments list --limit 10
ikw payments inspect <id>
ikw webhooks list

Auth / config

Le CLI stocke sa configuration (environnements, tokens, baseUrl) localement via env-paths.

Connexion recommandee:

ikw login
# alias compatible
ikw auth login

Le login utilise un device flow: le CLI affiche un code, ouvre le dashboard Ikawaari, puis attend l'approbation dans le navigateur. Aucune session web n'est lue directement par le CLI.

Par defaut, sandbox pointe vers https://sandbox-api.ikawaari.com et live vers https://api.ikawaari.com. En developpement local:

ikw config set base-url https://localhost:44302

Options utiles:

ikw login --no-browser
ikw login --environment live
ikw login --timeout 900

Le stockage manuel reste disponible pour les usages techniques:

ikw auth login:manual --api-key ik_test_...

Notes:

• Plusieurs modes d’auth existent (ex: API key, merchant JWT, ops token) selon les endpoints.
• Les détails (fichiers/format exact) sont gérés dans src/core/config-store.ts.

Intégration avec cli-sdk

Le repo contient apps/cli-sdk qui définit:

• CommandDefinition[] (source de vérité)
• CommandRegistry / CommandParser
• Exécuteurs Node/Browser

Côté CLI, un adapter Commander (WIP) permet de générer automatiquement les subcommands à partir de la registry:

• src/adapters/commander-adapter.ts

Windows / PowerShell

Si npm échoue avec une erreur du type npm.ps1 ... execution of scripts is disabled, tu as 2 options:

• Ajuster la policy PowerShell (recommandé pour un poste dev)
• Ou exécuter npm via cmd.exe / Git Bash

Développement

• Entrée principale: src/index.ts
• Client HTTP: src/core/api-client.ts (fetch, retries, headers, auth)
• Output helpers: src/core/output.ts (table/json/human)