lomi.

Référence des commandes

Référence complète de toutes les commandes, sous-commandes et options globales du CLI lomi.

Toutes les commandes acceptent les options globales documentées dans Premiers pas.

Authentification

lomi login

Authentification via flux navigateur. Stocke un jeton CLI globalement.

lomi login
lomi login --no-browser
lomi login --profile sandbox

lomi logout

Supprime les identifiants stockés pour un profil.

lomi logout
lomi logout --profile sandbox

lomi whoami

Affiche le profil actif et le contexte compte.

lomi whoami

lomi status

Vérifie la connexion et l'API (GET /me + GET /accounts/balance).

lomi status

lomi list-profiles

Liste tous les profils d'authentification enregistrés.

lomi list-profiles

lomi switch <profil>

Définit le profil actif par défaut.

lomi switch sandbox

Configuration projet

lomi init

Génère client SDK, exemples et .env. Voir Initialiser un projet.

lomi init
lomi init --yes -e sandbox -L ts --api-key lomi_sk_test_xxx

lomi update

Met à jour @lomi./sdk dans le projet courant (via votre gestionnaire de paquets).

lomi update

lomi ui

Installe et met à jour les composants checkout lomi. UI depuis le registre docs. Voir Commandes lomi. UI.

lomi ui list
lomi ui add payment-provider-selector
lomi ui add --all
lomi ui update
lomi ui update --component payment-provider-selector

Aucune authentification requise. Nécessite Node.js, npx et un projet shadcn (components.json).

Sous-commandeDescription
listRécupère et affiche les composants du registre
add <name>Installe un composant via npx shadcn@latest add
add --allInstalle chaque entrée du registre
updateRéinstalle les composants verrouillés depuis .lomi/ui-lock.json
OptionS'applique àDescription
--pathadd, updateRépertoire projet cible
--yesadd, updateIgnorer l'invite shadcn init
--dry-runadd, updateAfficher les commandes sans les exécuter
--componentupdateMettre à jour un seul composant verrouillé

lomi init --with-ui <name> installe un composant après le scaffold. Voir Initialiser un projet.


Développement

lomi quickstart

Contrôle de connectivité du parcours type et prochaines étapes. Voir Commande quickstart.

lomi quickstart
lomi quickstart --json
lomi quickstart --skip-probe

lomi listen

Relais webhook cloud (sandbox d'abord). Voir Écouter les webhooks.

lomi listen
lomi listen http://localhost:3000/webhooks
lomi listen --allow-production

lomi probe

Exécute des contrôles de santé d'intégration en lecture seule.

lomi probe
lomi probe --send-test-webhook

lomi dev

Démarre un serveur webhook local. Voir Serveur de développement local.

lomi dev
lomi dev --port 4242
lomi dev --verify-signature
lomi dev --env-file .env.local
OptionDéfautDescription
-p, --port4242Port HTTP
--env-file.envChemin du fichier dotenv
--verify-signatureautoVérifier l'en-tête X-Lomi-Signature
--skip-rules-install-Ignorer l'invite règles agent

Endpoints :

  • POST /webhook, recevoir les événements webhook
  • GET /health, contrôle de santé

Webhooks

lomi webhooks list

Liste les URLs webhook configurés.

lomi webhooks list

lomi webhooks test <id>

Envoie un événement test vers un endpoint webhook.

lomi webhooks test wh_xxxxxxxx

Catalogue et transactions

lomi products list

Liste les produits et tarifs de votre organisation.

lomi products list

lomi transactions list

Liste les transactions récentes.

lomi transactions list
lomi transactions list --limit 25 --json
OptionDéfautDescription
--limit10Nombre maximum de transactions

lomi transactions get <id>

Récupère une transaction par ID (GET /transactions/{id}).

lomi transactions get 123e4567-e89b-12d3-a456-426614174000
lomi transactions get 123e4567-e89b-12d3-a456-426614174000 --json

lomi refunds create

Crée un remboursement pour une transaction complétée (POST /refunds).

lomi refunds create
lomi refunds create \
  --transaction-id 123e4567-e89b-12d3-a456-426614174000 \
  --amount 5000 \
  --reason duplicate_charge \
  --refund-type partial \
  --json
OptionDescription
--transaction-idUUID de la transaction à rembourser
--amountMontant du remboursement (même devise que la transaction)
--reasonMotif optionnel
--refund-typefull ou partial

lomi refunds list

Liste les remboursements.

lomi refunds list
lomi refunds list --status completed --limit 20 --json

lomi refunds get <id>

Récupère un remboursement par ID.

lomi refunds get ref_xxxxxxxx --json

Paiements

Ces commandes nécessitent une authentification et utilisent votre jeton CLI (pas d'ID marchand manuel).

lomi checkout create

Crée une session checkout hébergée via POST /checkout-sessions.

lomi checkout create
lomi checkout create \
  --amount 10000 \
  --currency XOF \
  --success-url https://example.com/success \
  --cancel-url https://example.com/cancel \
  --json

Le mode interactif demande : ID tarif ou montant, devise, URLs succès/annulation, e-mail client optionnel.

Le sans interaction exige --currency, --success-url, --cancel-url, et --amount ou --price-id.

Après création, affiche l'URL checkout et un extrait HTML embed prêt à coller avec @lomi./embed :

<!-- npm install @lomi./embed -->
<script type="module">
  import { loadLomiCheckout } from '@lomi./embed';
  document.getElementById('pay').addEventListener('click', () => {
    loadLomiCheckout({
      checkoutUrl: 'https://checkout.lomi.africa/checkout/cs_...',
      mode: 'modal',
      onComplete: (p) => console.log(p),
    });
  });
</script>
<button id="pay">Payer</button>

Voir Widget de paiement intégré pour le mode inline et dist/lomi.js auto-hébergé.

lomi payments create

Crée un lien de paiement via l'API payment links.

lomi payments create
lomi payments create --title "Facture #42" --amount 5000 --currency XOF --json

Le mode interactif demande : titre, montant, devise. Le sans interaction exige les trois options.


Règles agent IA

lomi install-rules

Installe la documentation lomi. pour les outils de codage IA. Voir Installer les règles agent.

lomi install-rules
lomi install-rules --target cursor --target llms.txt
lomi install-rules --force
CibleSortie
cursor.cursor/rules/lomi.*.mdc
claude-codeCLAUDE.md
codexAGENTS.md
vscode.github/instructions/lomi-*.instructions.md
llms.txtllms.txt à la racine du projet

Exemples de flux

Nouvelle intégration depuis zéro

npm install -g lomi.cli
lomi login
lomi quickstart
mkdir ma-boutique && cd ma-boutique
lomi init
lomi listen http://localhost:3000/webhooks

Profils sandbox vs production

lomi login --profile sandbox
lomi login --profile production
lomi switch sandbox
lomi init --profile sandbox

Pipeline CI

export LOMI_ACCESS_TOKEN=$CLI_TOKEN
lomi status
lomi init --yes -e sandbox -L ts --api-key $LOMI_SECRET_KEY --skip-package-install --skip-rules-install

Aide

lomi --help
lomi login --help
lomi init --help
lomi dev --help
lomi install-rules --help

Mainteneurs

La commande lomi docs est masquée dans l’aide par défaut. Elle s’adresse aux contributeurs lomi. qui travaillent sur la documentation dans le monorepo, pas aux intégrateurs marchands.

lomi docs check

Lance le lint docs et les contrôles de dérive OpenAPI depuis la racine du monorepo :

lomi docs check

Équivalent à cd apps/docs && pnpm lint && pnpm docs:drift. Voir Rédiger pour la doc lomi..

Sur cette page