Skip to content

Installation Guide

Setting up the Lucid Developer Platform requires the Lucid CLI for management and the Lucid SDK for building auditors.

🛠 Prerequisites

Ensure you have the following installed on your system:

  • Python 3.12+
  • Docker Desktop (or equivalent OCI runtime)
  • Kubectl (brew install kubectl)
  • Kind (brew install kind) — Required for local testing.

1. Install Lucid CLI

The CLI is your control plane. It handles cluster bootstrapping, auditor verification, and TEE-aware deployments.

# Clone the repository (if developing locally)
git clone https://github.com/Lucid-Computing/lucid-monorepo.git
cd lucid-monorepo

# Install the CLI in editable mode
pip install -e packages/lucid-cli

Verify the installation:

lucid --help

2. Install Lucid SDK

The SDK provides the Python decorators and types needed to build custom safety logic.

pip install -e packages/lucid-sdk

3. Configure Your Environment

Lucid interacts with the Lucid Verifier (SaaS). For local development, you'll use a developer API key.

# Temporary key for local dev (replaces with real SaaS key in production)
export LUCID_API_KEY="dev-key-123"

☸️ Cluster Readiness

To verify your environment is ready to communicate with a Kubernetes cluster:

kubectl cluster-info

Next, proceed to Cluster Setup to bootstrap Lucid into your cluster.