Skip to main content

Getting Started with Contract Lucidity

Welcome to the Contract Lucidity administrator documentation. This guide covers everything you need to deploy, configure, secure, and maintain a Contract Lucidity installation.

What is Contract Lucidity?

Contract Lucidity is an AI-powered contract intelligence platform that transforms how legal teams review, analyze, and manage contracts. It ingests documents (PDF, DOCX, images), extracts text via OCR, classifies the contract type, identifies and risk-scores individual clauses against your organization's playbook, generates detailed reports, and enables conversational Q&A over your contract portfolio — all powered by configurable AI providers (Anthropic Claude or OpenAI GPT).

What This Documentation Covers

  • Architecture — How the five services fit together and data flows through the system
  • Prerequisites — Hardware, software, and account requirements
  • Configuration — Every environment variable, with defaults and descriptions
  • Deployment — Docker Compose, Kubernetes, and production hardening
  • Playbook — Configuring your organization's contract review standards
  • Security — Authentication, network isolation, and best practices
  • Operations — Monitoring, backups, troubleshooting, and upgrades
SectionDescription
ArchitectureSystem diagram, service descriptions, data flow
PrerequisitesWhat you need before you start
ConfigurationComplete environment variable reference
PlaybookSetting up your organization's review standards
SecurityAuthentication, CORS, network isolation

System Overview

cl-frontend serves the React UI and proxies API requests to the backend. cl-backend handles authentication, file uploads, and API routes. cl-redis brokers tasks between the backend and worker. cl-worker runs the document processing pipeline (extraction, classification, analysis, embedding, report generation). cl-db stores all persistent data including vector embeddings for semantic search.

First Boot

On first startup, the backend automatically:

  1. Creates the pgvector extension in PostgreSQL
  2. Runs all Alembic database migrations
  3. Seeds a default admin account, a default "General" project, system configuration, action pathways, playbook tags, and sample playbook entries

You can then log in with the default admin credentials (see Configuration) and complete the setup wizard.