Yeredon CLI

Testez votre intégration Yeredon en local : recevez les webhooks de test sur votre machine, sans tunnel ni URL publique, rejouez-les et déclenchez des vérifications.

npx yeredon login                 # une fois : collez votre clé de test
npx yeredon --to 3000/webhook     # interface sur http://localhost:2230

Ensuite, npx yeredon suffit : la clé et la destination sont retenues. Installation globale possible : npm install -g yeredon, puis yeredon ….

Commandes

| Commande | Rôle | |---|---| | yeredon login | Enregistre votre clé de test (une seule fois). | | yeredon | Lance l'interface et reçoit les événements. | | yeredon --to 3000/webhook | … en les envoyant à http://localhost:3000/webhook (retenu pour la suite). | | yeredon approve · reject · review · resubmit | Déclenche une vérification de test avec cette décision. | | yeredon listen | Reçoit et envoie les événements sans interface (scripts, CI). | | yeredon secret | Affiche le secret qui signe les événements envoyés. | | yeredon logout | Oublie la clé enregistrée. | | yeredon help | Aide. |

Options : --to, --port (2230 par défaut, sinon le suivant libre), --open (ouvre le navigateur), --ref (référence de la vérification déclenchée), --key (clé sans l'enregistrer, ou YEREDON_API_KEY), --api (autre serveur, ou YEREDON_API_URL).

La destination s'écrit au plus court : 3000, 3000/webhook, localhost:3000/webhook ou une URL complète.

L'interface

• Événements en direct, avec la requête envoyée et la réponse de votre serveur.
• Rejouer un événement après avoir corrigé votre code, ou le copier en cURL.
• Historique des envois, filtre des échecs, filtre par vérification.
• Pause : les événements sont affichés sans être envoyés.
• Boutons pour déclencher une vérification approuvée, refusée, à relire ou à reprendre.

Comment ça marche

Le CLI ouvre une connexion sortante vers Yeredon et reçoit les événements de test de votre organisation. Il les envoie à votre serveur local comme de vrais webhooks : mêmes en-têtes (KYC-Signature, KYC-Event, KYC-Delivery), même corps. Aucun port à ouvrir.

Ils sont signés avec un secret local (whsec_…), créé au premier lancement et conservé : mettez-le une fois dans la configuration de votre environnement de développement. Il est différent du secret de vos webhooks de production.

La clé doit être une clé de test (kyc_test_…) avec les droits sessions:read et sessions:create. Les clés live sont refusées : l'outil n'agit jamais sur des données réelles.

Sécurité

• La clé est enregistrée dans ~/.config/yeredon/cli.json (Linux, macOS) ou %APPDATA%\yeredon\cli.json (Windows), lisible par vous seul. yeredon logout l'efface.
• L'interface n'écoute que sur 127.0.0.1 et n'accepte que localhost, 127.0.0.1, [::1] et yeredon.localhost comme nom d'hôte (protection contre le DNS rebinding).
• Ses actions exigent l'origine de l'interface et un en-tête propre : un autre site ouvert dans le navigateur ne peut pas les déclencher. La clé ne quitte jamais le processus du CLI.

Développement

Node.js 18.17 ou plus, aucune dépendance.

npm test
node bin/yeredon.js --api http://localhost:5000     # contre un yeredon-server local

Publier une version

1. Mettre à jour version dans package.json et CHANGELOG.md.
2. git tag v0.1.0 && git push --tags : le workflow « Publication » teste et publie sur npm (secret NPM_TOKEN à créer dans le dépôt GitHub).

Ou à la main : npm login puis npm publish.

Licence

MIT © 2026 Morbin. Voir LICENSE.