Configuration¶
Learn how to configure Lean Explore for your needs.
CLI Configuration¶
API Key¶
Set your API key for the remote API:
The API key is stored in your user configuration directory and will be used for all API requests.
OpenAI API Key¶
Set your OpenAI API key for chat functionality:
The OpenAI API key is stored in your user configuration directory and will be used for chat sessions.
Environment Variables¶
You can also configure Lean Explore using environment variables:
API Key¶
Base URL¶
For local servers or custom endpoints:
Python Configuration¶
Using Environment Variables¶
import os
from lean_explore.api.client import Client
# Read from environment
api_key = os.getenv("LEAN_EXPLORE_API_KEY")
base_url = os.getenv("LEAN_EXPLORE_BASE_URL", "https://www.leanexplore.com/api/v1")
client = Client(api_key=api_key, base_url=base_url)
Direct Configuration¶
from lean_explore.api.client import Client
# Configure directly
client = Client(
api_key="your-api-key",
base_url="https://www.leanexplore.com/api/v1",
timeout=30.0 # Custom timeout
)
Local Backend Configuration¶
Data Directory¶
By default, local data is stored in ~/.leanexplore/data. You can configure this:
from lean_explore.local.service import Service
from lean_explore import defaults
# Custom data directory
service = Service(data_dir="/path/to/custom/data")
Database URL¶
For local backend, you can specify a custom database URL:
from lean_explore.local.service import Service
service = Service(
db_url="sqlite:///path/to/custom/database.db"
)
HTTP Server Configuration¶
Backend Selection¶
# Use remote API backend
leanexplore http serve --backend api --api-key YOUR_API_KEY
# Use local backend
leanexplore http serve --backend local
Port and Host¶
# Custom port
leanexplore http serve --backend local --port 8080
# Custom host
leanexplore http serve --backend local --host 0.0.0.0
MCP Server Configuration¶
# API backend
leanexplore mcp serve --backend api --api-key YOUR_API_KEY
# Local backend
leanexplore mcp serve --backend local
Configuration Files¶
Configuration is stored in:
- macOS/Linux: ~/.config/leanexplore/config.toml
- Windows: %APPDATA%\leanexplore\config.toml
The configuration file uses TOML format: