Quickstart command

lomi quickstart is a non-destructive golden-path check. It verifies your CLI token and API connectivity, then prints the commands most teams run next.

Usage

lomi quickstart

Machine-readable output for scripts and agents:

lomi quickstart --json

Skip API checks (offline or docs-only):

lomi quickstart --skip-probe

What it checks

Unless --skip-probe is set, quickstart runs:

1. GET /, API connectivity
2. GET /me, identity and environment
3. GET /accounts/balance, authenticated balance read

JSON response shape

{
  "status": "ready",
  "profile": "default",
  "organization": "Your Org",
  "environment": "sandbox",
  "probe": { "passed": 3, "failed": 0 },
  "next_steps": [
    {
      "command": "lomi checkout create --amount 10000 ...",
      "description": "Create a sandbox test checkout session"
    }
  ]
}

Next steps

• CLI quickstart guide: full install-to-webhook workflow
• Command reference: every CLI command