Docslomi. with CLIOverview

lomi. CLI

The lomi. CLI helps you integrate lomi.’s payment services into your applications. It provides tools for:

  • Project initialization and configuration
  • Payment operations management
  • Webhook endpoint configuration
  • API key management
  • Integration status monitoring

Installation

Install the lomi. CLI using npm:

npm install lomi.cli

Authentication

The CLI requires authentication to interact with the lomi. API. You can authenticate using:

  1. Environment Variable:
export LOMI_API_KEY=your_api_key_here
  1. Interactive Login:
lomi login

Core Commands

lomi init

Initializes a new lomi. project in your current directory:

lomi init

This command:

  • Creates a lib/lomi.ts file with client configuration
  • Sets up environment variables in .env
  • Installs the lomi. client package
  • Configures your API key

lomi dev

Starts the development environment:

lomi dev

Features:

  • Local development server
  • Integration testing support
  • Environment configuration

lomi status

Displays your integration status:

lomi status

Shows:

  • API connectivity status
  • Account information
  • Integration health

lomi payments

Manage payment operations:

# List payments
lomi payments list
 
# Get payment details
lomi payments get <payment_id>

lomi webhook

Manage webhook endpoints:

# Register new webhook
lomi webhook register
 
# List webhooks
lomi webhook list --merchant-id <merchant_id>

lomi api-key

Manage API keys:

# List keys
lomi api-key list
 
# Create key
lomi api-key create

Global Options

  • --api-key: Set API key
  • --env: Set environment (default: ‘production’)
  • --json: JSON output format

Next Steps

For command details, use lomi help [command]. For support, contact hello@lomi.africa.