Skip to main content

​
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
Verify the installation: 
lucitra --version

​
Configure

1

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.
2

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
3

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.
VariableDescriptionEquivalent Config Key
LUCITRA_API_KEYAPI key for authenticationapi-key
LUCITRA_API_URLBase URL for the Lucitra APIapi-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:
  1. Command-line flags — --api-key (-k), --api-url
  2. Environment variables — LUCITRA_API_KEY, LUCITRA_API_URL
  3. 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

​
Next Steps

Command Reference

See all available CLI commands, flags, and example workflows.

API Authentication

Learn about API key scopes, rate limits, and enterprise tiers.