CLI Reference

Required

VariableDescription
LOKALIO_API_KEYYour Lokalio API key for authentication

Optional

VariableDescription
LOKALIO_API_URLCustom API base URL (for self-hosted instances)

Usage

# Direct
LOKALIO_API_KEY=your_key npx lokalio generate

# Via CI secrets (recommended)
# GitHub Actions: ${{ secrets.LOKALIO_API_KEY }}
# GitLab CI: $LOKALIO_API_KEY

# Custom API URL (self-hosted)
LOKALIO_API_URL=https://api.your-company.com LOKALIO_API_KEY=your_key npx lokalio generate

CI Integration

Both CI platforms reference the key through their respective secret management:

GitHub Actions:

with:
  api_key: ${{ secrets.LOKALIO_API_KEY }}

GitLab CI:

variables:
  LOKALIO_API_KEY: $LOKALIO_API_KEY

CLI Reference

Complete reference for the Lokalio CLI — commands, flags, and environment variables.

CI/CD Setup

Integrate Lokalio into your CI pipeline with GitHub Actions or GitLab CI.

On this page

RequiredOptionalUsageCI Integration