Skip to content

Installation

Get the Lucid CLI installed and ready to use.

Alpha Access Required

The Lucid CLI and SDK are available to alpha participants. Request access to get started.

Quick Install

pip install lucid-clilucid --versionlucid-cli 0.1.0

That's it! Verify everything works:

lucid --helpUsage: lucid [OPTIONS] COMMAND [ARGS]...

Core Commands:
apply Deploy environment (serverless or self-hosted)
diff Preview changes before applying
status View agent status
logs Stream agent logs
start Start a stopped agent
stop Stop a running agent
teardown Clean up environment
export Export cluster state to YAML

Serverless Mode:
lucid apply --model llama-3.1-8b
lucid catalog models List available models
lucid catalog auditors List auditor profiles
lucid verify endpoint Verify TEE attestation

Other Commands:
login Authenticate with Lucid platform
catalog Browse resource catalog (apps, models, auditors)
passport View AI passports
auditor Manage Lucid Auditors
verify Verify TEE attestation

Authenticate

Connect to the Lucid platform:

lucid loginEmail: user@example.com
Password:
Logged in as user@example.com

For automation and CI/CD, use the LUCID_API_KEY environment variable:

# Using API key (recommended for CI/CD)
export LUCID_API_KEY=your-api-key
lucid status  # commands will use the API key automatically

Additional login options:

# Login with email (will prompt for password)
lucid login -e user@example.com

# Generate an API key after login
lucid login --generate-key

Credentials are stored in ~/.lucid/config.yaml.

Troubleshooting

Python Version Issues

Error: Python version 3.x is not supported

Lucid CLI requires Python 3.12 or higher.

python --versionPython 3.12.0

If you have multiple Python versions, use a specific one:

python3.12 -m pip install lucid-cli

Or use a tool like pyenv to manage versions.

pip SSL Errors

Error: SSL: CERTIFICATE_VERIFY_FAILED or similar SSL errors

  1. Update pip and certifi: 

    pip install --upgrade pip certifi

  2. On macOS, run the certificate installer: 

    /Applications/Python\ 3.12/Install\ Certificates.command

  3. Behind a corporate proxy, you may need to configure certificates: 

    pip install --trusted-host pypi.org --trusted-host github.com lucid-cli

Prerequisites

Before using lucid apply, ensure you have:

  • Python 3.12+
  • Docker Desktop (or equivalent OCI runtime) - for local development

Next Steps

You're ready to go!

  1. Serverless Quickstart - Deploy your first agent in minutes
  2. Set up your cluster - Configure where your agents run
  3. Deploy an agent - Get an AI workload running with auditing
Which SDK Do I Need?

Lucid publishes two SDKs for different use cases:

Package Install Use Case
lucid-auditor-sdk pip install lucid-auditor-sdk Build custom ClaimsAuditors (the ClaimsAuditor class, @claims decorator, serve())
lucid-sdk pip install lucid-sdk or npm install @lucid/sdk Call the Verifier API from your app (auto-generated typed client, Python + TypeScript)

Building auditors? You want lucid-auditor-sdk. See the Auditor Development Guide.

Integrating the Verifier API? You want lucid-sdk. See the SDK Reference.