CLI Installation

Install and configure the Lucitra CLI to run validations, upload datasets, and manage reports from your terminal or CI/CD pipeline.

Install

npm install -g @lucitra/cli

pnpm add -g @lucitra/cli

yarn global add @lucitra/cli

Verify the installation:

lucitra --version

Configure

Set your API key

Every request to Lucitra requires authentication. Add your API key to the CLI configuration so you do not need to pass it on every command.

lucitra config set api-key luci_your_api_key

You can generate API keys from the Lucitra Dashboard under Settings > API Keys.

Set the API URL (optional)

The CLI defaults to https://api.lucitra.io. Override this if you are using a self-hosted instance or a development environment.

lucitra config set api-url https://api.lucitra.io

Set a default project (optional)

If you work primarily in a single project, set a default project ID to avoid passing --project on every command.

lucitra config set project-id your-project-uuid

View Configuration

Check your current configuration at any time:

# List all configuration values
lucitra config list

# Get a specific value
lucitra config get api-url

Environment Variables

The CLI also reads configuration from environment variables. This is useful in CI/CD pipelines where you do not want to persist config to disk.

Variable	Description	Equivalent Config Key
`LUCITRA_API_KEY`	API key for authentication	`api-key`
`LUCITRA_API_URL`	Base URL for the Lucitra API	`api-url`

Environment variables take precedence over stored configuration, and command-line flags take precedence over both.

Precedence Order

The CLI resolves configuration in the following order, from highest to lowest priority:

Command-line flags — --api-key (-k), --api-url
Environment variables — LUCITRA_API_KEY, LUCITRA_API_URL
Stored configuration — values set via lucitra config set

Never commit API keys to version control. In CI/CD environments, use environment variables or your platform’s secret management.

CI/CD Example

- name: Validate synthetic data
  env:
    LUCITRA_API_KEY: ${{ secrets.LUCITRA_API_KEY }}
  run: |
    npm install -g @lucitra/cli
    lucitra upload ./data/training.zip --name "nightly-build" --format coco
    lucitra validate --dataset $DATASET_ID --type full

validate_data:
  image: node:20
  script:
    - npm install -g @lucitra/cli
    - lucitra upload ./data/training.zip --name "nightly-build" --format coco
    - lucitra validate --dataset $DATASET_ID --type full
  variables:
    LUCITRA_API_KEY: $LUCITRA_API_KEY

Core

Integrations

Tools

Installation

CLI Installation

Install

Configure

View Configuration

Environment Variables

Precedence Order

CI/CD Example

Next Steps

Command Reference

API Authentication

​CLI Installation

​Install

​Configure

​View Configuration

​Environment Variables

​Precedence Order

​CI/CD Example

​Next Steps

Command Reference

API Authentication

CLI Installation

Install

Configure

View Configuration

Environment Variables

Precedence Order

CI/CD Example

Next Steps