Getting started

The lomi. Command Line Interface (CLI) is the primary tool for interacting with our API, managing your projects, handling webhooks, and streamlining your development workflow directly from the terminal.

Installation

npm install -g lomi.

yarn global add lomi.

pnpm add -g lomi.

lomi. --version

Core commands

Here's a summary of the main commands available in the lomi. CLI:

• lomi. login: Authenticate the CLI with your lomi. account via a browser-based flow. This is required for most commands that interact with the lomi. API. Stores a global CLI Token.
• lomi. init: Initialize a lomi. integration in the current directory. Sets up example code for the lomi. Node.js SDK, creates a .env file, and installs dependencies.
• lomi. status: Check your current login status and verify connectivity to the lomi. API using the stored global CLI Token. (Mentioned in Configuration and Initialize).
• lomi. payments: Manage payment links (e.g., lomi. payments create). Requires login.
• lomi. webhook: Manage webhook endpoints (e.g., lomi. webhook register, lomi. webhook list). Requires login.
• lomi. dev: Start a local development server to receive and inspect webhook events sent to your machine, simplifying webhook testing. Requires login.

Global options

These options can be used with any command:

• -h, --help: Display help information for the CLI or a specific command.
• -v, --version: Display the installed version of the lomi. CLI.

Next steps

1. Authenticate: Run lomi. login first to enable API interactions.
2. Set up a project: Use lomi. init inside your project folder to configure the SDK.
3. Explore commands: Dive deeper into each command's specific documentation page using the sidebar navigation.

For detailed help on any command, use lomi. help [command]. For support, contact hello@lomi.africa.