Installation

pip (Recommended)

pip install learn-lock==0.1.8

From Source

git clone https://github.com/MitudruDutta/learnlock.git
cd learnlock
pip install -e .

Install Script (Inspect First)

Avoid piping a mutable remote script straight into your shell. Download it, review it, then run it.

curl -fsSLo install.sh https://raw.githubusercontent.com/MitudruDutta/learnlock/main/install.sh
less install.sh
bash install.sh

For automation, pin a tagged release or commit instead of the moving main branch.

API Keys Setup

LearnLock requires at least one API key. Both are free, and using both unlocks the best experience.

1. Groq API Key

1. Go to console.groq.com
2. Create an account (free)
3. Generate an API key

Groq covers extraction and fallback LLM calls.

2. Gemini API Key

1. Go to aistudio.google.com
2. Sign in with Google
3. Get API key

Gemini powers duel evaluation quality and the opt-in /visual frame inspector.

Set Environment Variables

macOS/Linux:

export GROQ_API_KEY=your_groq_key
export GEMINI_API_KEY=your_gemini_key

Windows (PowerShell):

$env:GROQ_API_KEY="your_groq_key"
$env:GEMINI_API_KEY="your_gemini_key"

Verify Installation

learnlock --version