Docs / Configuration
⭐ Star
⚙️ Configuration

Configuration

Control how OrcBot behaves. Configuration is file-backed, environment-aware, and editable from the TUI.

📁 Resolution Order

OrcBot looks for configuration in this order (first found wins):

  1. Environment variables
  2. ./orcbot.config.yaml (current directory)
  3. ~/orcbot.config.yaml (home directory)
  4. ~/.orcbot/orcbot.config.yaml (data directory)

🔧 Key Settings

Core

  • agentName
  • modelName
  • maxStepsPerAction
  • maxMessagesPerAction
  • messageDedupWindow

Autonomy

  • autonomyEnabled
  • autonomyInterval
  • autonomyBacklogLimit
  • maxActionRunMinutes
  • maxStaleActionMinutes

Providers

  • llmProvider
  • openaiApiKey
  • googleApiKey
  • nvidiaApiKey
  • openrouterApiKey

Search

  • serperApiKey
  • braveSearchApiKey
  • searxngUrl
  • searchProviderOrder

Channels

  • telegramToken
  • whatsappEnabled
  • whatsappAutoReplyEnabled
  • discordToken

Browser

  • browserEngine
  • lightpandaEndpoint
  • lightpandaPath
  • browserProfileDir

💻 TUI Management

Open the TUI with orcbot ui to configure models, tooling, and connections without editing files.

orcbot ui

🐼 Lightpanda Browser

Lightpanda is a lightweight headless browser that uses 9x less RAM and is 11x faster than Chrome. Perfect for low-memory VPS deployments.

Quick Setup

# Install Lightpanda
orcbot lightpanda install

# Start the browser server (background)
orcbot lightpanda start -b

# Enable as default browser engine
orcbot lightpanda enable

# Check status
orcbot lightpanda status

CLI Commands

  • orcbot lightpanda install — Download and install Lightpanda
  • orcbot lightpanda start [-b] — Start browser server (-b for background)
  • orcbot lightpanda stop — Stop background server
  • orcbot lightpanda status — Check installation and server status
  • orcbot lightpanda enable — Set Lightpanda as default browser
  • orcbot lightpanda disable — Switch back to Playwright/Chrome

Config Options

  • browserEngine — playwright (default) or lightpanda
  • lightpandaEndpoint — CDP endpoint (default: ws://127.0.0.1:9222)
  • lightpandaPath — Path to binary (auto-set by installer)

Platform Support

  • Linux x64 ✅
  • macOS ARM64 (Apple Silicon) ✅
  • Windows: Use WSL2 or Docker

Docker Alternative

docker run -d --name lightpanda -p 9222:9222 lightpanda/browser:nightly

Then set: orcbot config set lightpandaEndpoint ws://localhost:9222