lomi. UI commands
Install and update lomi. UI checkout components from the live docs registry via lomi ui.
lomi ui wraps shadcn/ui to install lomi. UI checkout blocks from the public registry at docs.lomi.africa/r. Components are always fetched from the latest docs deploy, no CLI release is required when new blocks ship.
No login required. These commands work in any React + Tailwind project with shadcn configured.
Prerequisites
- Node.js 18+ with
npxon your PATH - A project with shadcn/ui initialized (
components.json)
If components.json is missing, lomi ui add offers to run npx shadcn@latest init -y -d.
Usage
List available components
lomi ui listFetches the registry index and prints name, title, and description for each block. Registry version is shown at the bottom.
Add a component
lomi ui add payment-provider-selectorEquivalent to:
npx shadcn@latest add https://docs.lomi.africa/r/payment-provider-selector.jsonAdd all components
lomi ui add --allInstalls every block in the registry sequentially. shadcn resolves registryDependencies between items.
Update installed components
lomi ui update
lomi ui update --component payment-provider-selectorRe-runs shadcn add for components recorded in .lomi/ui-lock.json, pulling the latest files from the registry.
Options
Shared flags for add and update:
| Flag | Description |
|---|---|
--path <dir> | Target project directory (default: current directory) |
--yes | Skip shadcn init prompt when components.json is missing |
--dry-run | Print npx shadcn commands without executing |
add-only:
| Flag | Description |
|---|---|
--all | Install every registry item |
update-only:
| Flag | Description |
|---|---|
--component <name> | Update a single locked component |
Lockfile
Successful installs write .lomi/ui-lock.json:
{
"registry_version": "1.0.0",
"registry_url": "https://docs.lomi.africa/r/registry.json",
"components": [
{
"name": "payment-provider-selector",
"installed_at": "2026-06-06T12:00:00Z"
}
]
}lomi ui update reads this file to know which components to refresh.
Staging / local registry
Override the registry URL when testing docs builds:
export LOMI_UI_REGISTRY_URL=http://localhost:3000/r/registry.json
lomi ui listThe CLI derives per-component URLs and the index URL from this base path.
During project init
lomi init can install a component after scaffolding:
lomi init --with-ui payment-provider-selector --yes \
-e sandbox -L ts --api-key lomi_sk_test_xxxInteractively, lomi init may prompt: Install a lomi. UI checkout component?
Use --skip-ui-install to skip the prompt.
Next steps
- lomi. UI overview: component catalog and customization
- Initialize a project: SDK scaffold + optional UI install
- Command reference: all CLI commands