clm-system/clm-system/README.md

CLM System - Contract Management Made Simple

An AI-powered contract management system that reads your contracts, answers questions, and alerts you about important dates and conflicts.

Quick Start

1. Install Dependencies

# Using uv (recommended)
uv sync

# Or using pip
pip install -r requirements.txt

2. Set Up

# Copy environment template
cp .env.example .env

# Add your OpenAI API key to .env file
# OPENAI_API_KEY=your_key_here

3. Run

# Easy way - just run the package
clm-system

# Or traditional way
streamlit run app.py

What You Can Do

• Upload contracts: Drag and drop PDF, Word, or text files
• Ask questions: "What contracts expire this month?" or "Show me all NDA agreements"
• Get alerts: Automatic daily emails about expiring contracts and conflicts
• Find similar docs: Upload a contract and find related ones

Manual Tasks

# Check contracts right now
python scripts/manual_scan.py

# Generate a report
python scripts/generate_reports.py

Need Help?

• App won't start? Check your OpenAI API key in .env
• OCR not working? Install Tesseract: brew install tesseract (Mac) or apt-get install tesseract-ocr (Linux)
• Email alerts? Add your email settings to .env