lean-xplore 0.4.2

A search engine for Lean 4 declarations.

LeanExplore

A search engine for Lean 4 declarations

A search engine for Lean 4 declarations. This project provides tools and resources for exploring the Lean 4 ecosystem. Lean Explore enables semantic search across multiple Lean projects including Mathlib, Batteries, Std, PhysLean, Init, and Lean, helping you discover relevant theorems, definitions, and other declarations using natural language queries.

Features

• 🔍 Semantic Search: Find Lean declarations using natural language queries
• 📚 Multi-Project Support: Search across Mathlib, Batteries, Std, PhysLean, Init, and Lean
• 🚀 Multiple Interfaces: Use via CLI, Python API, HTTP server, or MCP server
• 🏠 Local Backend: Run searches locally with your own data (no API key required)
• 🔗 Dependency Tracking: Explore relationships between declarations
• 📊 Ranked Results: Results are ranked using semantic similarity, PageRank, and lexical matching

Installation

Install from PyPI:

pip install lean-xplore

Requirements

• Python 3.10 or higher
• pip (Python package installer)

Quick Start

Getting an API Key

To use the remote API, you'll need an API key. API keys can be obtained from https://www.leanexplore.com. Once you have your API key, configure it using:

leanexplore configure api-key YOUR_API_KEY

Alternatively, you can use the local backend without an API key (see Local Backend below).

Command Line

Search for Lean declarations:

# Basic search
leanexplore search "natural numbers"

# Search with package filters (limit results to specific packages)
leanexplore search "monoid" --pkg Mathlib --pkg Batteries

# Limit the number of results
leanexplore search "topology" --limit 5

The CLI will automatically use your configured API key, or you can use the local backend:

# Use local backend (no API key needed)
leanexplore search "natural numbers" --backend local

Python API

import asyncio
from lean_explore.api.client import Client

async def main():
    # Initialize client with API key
    client = Client(api_key="your-api-key")
    
    # Perform a search
    results = await client.search("natural numbers")
    
    # Display results
    print(f"Found {len(results.items)} results")
    for item in results.items[:5]:
        print(f"{item.primary_declaration.lean_name}: {item.informal_name}")
        if item.informal_description:
            print(f"  {item.informal_description[:100]}...")

asyncio.run(main())

You can also search multiple queries at once:

async def main():
    client = Client(api_key="your-api-key")
    
    # Search multiple queries
    results = await client.search([
        "natural numbers",
        "group theory",
        "topology"
    ])
    
    for result in results:
        print(f"\nQuery: {result.query}")
        print(f"Results: {len(result.items)}")

asyncio.run(main())

Local Backend

Run searches locally without an API key. This is useful for offline access, faster queries, or when you want full control over the data.

# Download local data (database, embeddings, and search index)
leanexplore data fetch

# Start local HTTP server
leanexplore http start --backend local

The server will be available at http://localhost:8000. You can query it via HTTP or use the Python client:

from lean_explore.api.client import Client

# Connect to local server
client = Client(base_url="http://localhost:8000")

# Use as normal (no API key needed)
results = await client.search("natural numbers")

Additional Features

• MCP Server: Integrate with AI agents using the Model Context Protocol

  leanexplore mcp start --backend api --api-key YOUR_API_KEY
  

• HTTP Server: Run your own API server

  leanexplore http start --backend local
  

• AI Chat: Interact with an AI agent that can search Lean code

  leanexplore chat --backend api --api-key YOUR_API_KEY
  

Documentation

For detailed documentation, API reference, configuration options, and more examples, visit https://kellyjdavis.github.io/lean-explore.

The documentation includes:

• Complete installation and setup guides
• Detailed CLI usage and options
• Python API reference with examples
• HTTP server configuration
• MCP server integration
• Local backend setup and data management
• Development guides and contributing information

This code is distributed under an Apache License (see LICENSE).

Cite

If you use LeanExplore in your research or work, please cite it as follows:

General Citation:

Justin Asher. (2025). LeanExplore: A search engine for Lean 4 declarations. LeanExplore.com. (GitHub: https://github.com/justincasher/lean-explore).

BibTeX Entry:

@software{Asher_LeanExplore_2025,
  author = {Asher, Justin},
  title = {{LeanExplore: A search engine for Lean 4 declarations}},
  year = {2025},
  url = {http://www.leanexplore.com},
  note = {GitHub repository: https://github.com/justincasher/lean-explore}
}