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 sandboxlomi logout
Supprime les identifiants stockés pour un profil.
lomi logout
lomi logout --profile sandboxlomi whoami
Affiche le profil actif et le contexte compte.
lomi whoamilomi status
Vérifie la connexion et l'API (GET /me + GET /accounts/balance).
lomi statuslomi list-profiles
Liste tous les profils d'authentification enregistrés.
lomi list-profileslomi switch <profil>
Définit le profil actif par défaut.
lomi switch sandboxConfiguration 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_xxxlomi update
Met à jour @lomi./sdk dans le projet courant (via votre gestionnaire de paquets).
lomi updatelomi 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-selectorAucune authentification requise. Nécessite Node.js, npx et un projet shadcn (components.json).
| Sous-commande | Description |
|---|---|
list | Récupère et affiche les composants du registre |
add <name> | Installe un composant via npx shadcn@latest add |
add --all | Installe chaque entrée du registre |
update | Réinstalle les composants verrouillés depuis .lomi/ui-lock.json |
| Option | S'applique à | Description |
|---|---|---|
--path | add, update | Répertoire projet cible |
--yes | add, update | Ignorer l'invite shadcn init |
--dry-run | add, update | Afficher les commandes sans les exécuter |
--component | update | Mettre à 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-probelomi listen
Relais webhook cloud (sandbox d'abord). Voir Écouter les webhooks.
lomi listen
lomi listen http://localhost:3000/webhooks
lomi listen --allow-productionlomi probe
Exécute des contrôles de santé d'intégration en lecture seule.
lomi probe
lomi probe --send-test-webhooklomi 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| Option | Défaut | Description |
|---|---|---|
-p, --port | 4242 | Port HTTP |
--env-file | .env | Chemin du fichier dotenv |
--verify-signature | auto | Vérifier l'en-tête X-Lomi-Signature |
--skip-rules-install | - | Ignorer l'invite règles agent |
Endpoints :
POST /webhook, recevoir les événements webhookGET /health, contrôle de santé
Webhooks
lomi webhooks list
Liste les URLs webhook configurés.
lomi webhooks listlomi webhooks test <id>
Envoie un événement test vers un endpoint webhook.
lomi webhooks test wh_xxxxxxxxCatalogue et transactions
lomi products list
Liste les produits et tarifs de votre organisation.
lomi products listlomi transactions list
Liste les transactions récentes.
lomi transactions list
lomi transactions list --limit 25 --json| Option | Défaut | Description |
|---|---|---|
--limit | 10 | Nombre 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 --jsonlomi 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| Option | Description |
|---|---|
--transaction-id | UUID de la transaction à rembourser |
--amount | Montant du remboursement (même devise que la transaction) |
--reason | Motif optionnel |
--refund-type | full ou partial |
lomi refunds list
Liste les remboursements.
lomi refunds list
lomi refunds list --status completed --limit 20 --jsonlomi refunds get <id>
Récupère un remboursement par ID.
lomi refunds get ref_xxxxxxxx --jsonPaiements
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 \
--jsonLe 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 --jsonLe 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| Cible | Sortie |
|---|---|
cursor | .cursor/rules/lomi.*.mdc |
claude-code | CLAUDE.md |
codex | AGENTS.md |
vscode | .github/instructions/lomi-*.instructions.md |
llms.txt | llms.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/webhooksProfils sandbox vs production
lomi login --profile sandbox
lomi login --profile production
lomi switch sandbox
lomi init --profile sandboxPipeline 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-installAide
lomi --help
lomi login --help
lomi init --help
lomi dev --help
lomi install-rules --helpMainteneurs
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..