Skip to content
lynox

Getting Started

Prerequisites

Section titled “Prerequisites”

  • An LLM credential for one of the two natively-supported providers:

    • Claude (Anthropic) — recommended primary, direct API. Prompt caching makes cache-heavy workflows the cheapest option per token of real work. Tested on every release.
    • Mistral — France/EU, OpenAI-compatible adapter pinned to api.mistral.ai. Lower list prices than Claude; pick it for sovereignty or for uncached workloads where the lower per-token rate dominates. Tested on every release.

    Other endpoints — OpenAI itself, Ollama, LM Studio, Groq, vLLM, Gemini, the Anthropic-compatible “custom” proxy path (e.g. a LiteLLM proxy exposing the Anthropic Messages route), and Google Vertex AI — are wired but not regularly tested. They work in principle and you can configure them via ~/.lynox/config.json or environment variables, but expect rough edges around tool-calling reliability. See LLM Providers.

The installer walks you through provider selection and credential entry. Most users start with Anthropic — you can switch anytime in Settings → Provider.

Install

Section titled “Install”
Section titled “npx installer (recommended)”
Terminal window
npx @lynox-ai/core

The interactive installer checks prerequisites, asks for your AI provider and API key, generates docker-compose.yml, .env, and SearXNG config, then starts everything automatically. Your browser opens at localhost:3000 once the health check passes.

Requires: Node.js 22+, Docker + Docker Compose.

Manual Docker Compose

Section titled “Manual Docker Compose”

If you prefer to set things up yourself:

Terminal window
# 1. Clone the repo (contains docker-compose.yml + SearXNG config)
git clone https://github.com/lynox-ai/lynox.git && cd lynox


# 2. Copy .env.example and UNCOMMENT + set your AI provider key
#    (.env.example ships with ANTHROPIC_API_KEY commented out so the file
#    can stay in the repo; you must remove the leading `#` and paste the
#    key before starting the container).
cp .env.example .env
# then: edit .env, uncomment the `ANTHROPIC_API_KEY=` line, paste your key


# 3. Start lynox + SearXNG (web search)
docker compose up -d

Open localhost:3000 and enter the access token from docker logs lynox.

First Run

Section titled “First Run”

After setup, lynox opens at localhost:3000.

If you started without an API key (e.g. manual Docker Compose without .env), lynox starts in a limited state — the chat input is disabled until setup is complete. A setup banner appears at the top with a provider-aware wizard (Anthropic / Mistral / Custom) where you enter your credentials. They’re stored encrypted in the local vault.

Try something:

  • “Summarize this PDF” — drop a file into the chat
  • “Monitor example.com every day and alert me if something changes”
  • “Create a weekly report template for my team”

lynox remembers context across conversations. The more you use it, the more it learns about your business.

Verify Your Setup

Section titled “Verify Your Setup”
  1. Container running — docker ps shows lynox with status (healthy)
  2. Web UI loads — Open localhost:3000 and enter the token
  3. Status bar — The bar at the bottom shows the active provider and API health (e.g. Anthropic · API OK), today’s cost (e.g. $0.04), and today’s run count. Click the cost pill to open the Activity Hub at /app/activity.
  4. Send a message — Type “Hello” and get an AI response

Common Issues

Section titled “Common Issues”

“API Key Invalid” — Check your ANTHROPIC_API_KEY starts with sk-ant- and is active in console.anthropic.com.

Port 3000 in use — Map to a different port: docker run -p 8080:3000 ...

Wrong image — Use ghcr.io/lynox-ai/lynox:latest — it includes both Engine and Web UI.

Next Steps

Section titled “Next Steps”