Skip to content

Installation

This guide covers the different ways to install and set up LORG.

Prerequisites

  • Node.js: Version 18 or higher
  • npm: Comes with Node.js
  • OpenAI API Key: Required for LLM functionality

Installation Methods

Install LORG globally to use the CLI:

npm install -g lorg

Or install locally in your project:

npm install lorg

From Source

Clone the repository and install dependencies:

git clone https://github.com/user/lorg.git
cd lorg
npm install
npm run build

Docker

Build and run using Docker:

docker build -t lorg .
docker run -e OPENAI_API_KEY=your-key -p 3000:3000 lorg

Configuration

Environment Variables

Set your OpenAI API key:

export OPENAI_API_KEY=your-api-key-here

$env:OPENAI_API_KEY="your-api-key-here"

set OPENAI_API_KEY=your-api-key-here

Optional Environment Variables

Variable Default Description
OPENAI_BASE_URL OpenAI default Custom OpenAI API endpoint
LORG_DEFAULT_MODEL gpt-4o-mini Default model for queries
LORG_SEARCH_API_URL https://search-dev.d736.uk/search SearxNG API URL
LORG_SEARCH_ENGINES google,yahoo,bing,duckduckgo Search engines to use
LORG_SEARCH_LIMIT 20 Maximum search results

Verify Installation

Check that LORG is installed correctly:

lorg --version

Run a test search:

lorg "Hello, world"

Next Steps