Merge Installation / Introduction docs

Author: mythz

content/docs/getting-started/index.mdx

@@ -1,163 +1,98 @@
 ---
-title: Introduction
-description: Introducing llms.py - Lightweight OpenAI compatible CLI and server gateway
+title: Installation
+description: How to install llms.py
 ---
 
-# Introducing llms.py 🚀
+## Using pip
 
-We're excited to announce **[llms.py](https://github.com/ServiceStack/llms)** - a super lightweight CLI tool and OpenAI-compatible server that acts as a **configurable gateway** over multiple configurable Large Language Model (LLM) providers.
+The easiest way to install llms.py is using pip:
 
-## 🎯 OpenRouter but Local
+<ShellCommand>pip install llms-py</ShellCommand>
 
-**llms.py** is designed as a **unified gateway** that seamlessly connects you to multiple LLM providers through a single, consistent interface. Whether using cloud APIs or local models, `llms` provides intelligent routing and automatic failover to ensure your AI workflows connect to your chosen providers in your preferred priority - whether optimizing for cost, performance, or availability.
+## Using Docker
 
-### ⚡ Ultra-Lightweight Architecture
+### Pre-built Docker Images
 
+Pull and run the latest image:
 
-1. **Simplicity**: Just one [llms.py](https://github.com/ServiceStack/llms/blob/main/llms/main.py) file (easily customizable)
-2. **Single Dependency**: Only requires `aiohttp` (Pillow optional)
-   - Zero Dependencies for ComfyUI - Ideal for use in Custom Nodes
-3. **Flexibility**: Works with any OpenAI-compatible client or framework
-4. **Reliability**: Automatic failover ensures your workflows never break
-5. **Economy**: Intelligent routing minimizes API costs
-6. **Privacy**: Mix local and cloud models based on your data sensitivity
-7. **Future-Proof**: Easily add new providers as they emerge
-8. **No Setup**: Just download and use, configure preferred LLMs in [llms.json](https://github.com/ServiceStack/llms/blob/main/llms/llms.json)
+<ShellCommand>docker pull ghcr.io/servicestack/llms:latest</ShellCommand>
 
-**llms.py** transforms the complexity of managing multiple LLM providers into a simple, unified experience. 
-Whether you're researching capabilities of new models, building the next breakthrough AI application, 
-or just want reliable access to the best models available, llms.py has you covered.
+<ShellCommand>docker run -p 8000:8000 -e GROQ_API_KEY=$GROQ_API_KEY ghcr.io/servicestack/llms:latest</ShellCommand>
 
-Get started today and avoid expensive cloud lock-ins with the freedom of provider-agnostic AI development! 🎉
+### Using docker compose (Recommended)
 
-## 🌐 Configurable Multi-Provider Gateway
+1. Download the docker-compose.yml file:
 
-Acts as an intelligent gateway that can route requests for 160+ models across:
+<ShellCommand>curl -O https://raw.githubusercontent.com/ServiceStack/llms/refs/heads/main/docker-compose.yml</ShellCommand>
 
-### Cloud Providers with Free Tiers
+2. Create a `.env` file with your API keys:
 
-- OpenRouter
-- Groq
-- Codestral
-- Google
+```bash
+OPENROUTER_API_KEY=sk-or-...
+GROQ_API_KEY=gsk_...
+GOOGLE_FREE_API_KEY=AIza...
+```
 
-### Premium Cloud Providers
+3. Start the service:
 
-- OpenAI
-- Anthropic
-- Google
-- Grok
-- Qwen
-- Mistral
+<ShellCommand>docker compose up -d</ShellCommand>
 
-### Local Providers
+### Build from Source
 
-- Ollama
-  - Restrict access to custom models
-  - Or auto-discovery of installed models
+If you've cloned the repository:
 
-### Custom Providers
+<ShellCommand>git clone https://github.com/ServiceStack/llms</ShellCommand>
 
-Use JSON config to add any OpenAI-compatible API endpoints and models
+<ShellCommand>cd llms</ShellCommand>
 
-## 🔄 Intelligent Request Routing
+<ShellCommand>docker compose -f docker-compose.local.yml up -d --build</ShellCommand>
 
-- **Automatic Failover**: If one provider fails, automatically retry with the next available provider
-- **Cost Optimization**: Define free/cheap/local providers first to minimize costs
-- **Model Mapping**: Use unified model names that map to different provider-specific names
+## Setting Up API Keys
 
-## 🚀 Key Features
+Set environment variables for the providers you want to use:
 
-### 🎨 ChatGPT-like Web UI
+```bash
+export OPENROUTER_API_KEY="sk-or-..."
+export GROQ_API_KEY="gsk_..."
+export GOOGLE_FREE_API_KEY="AIza..."
+export ANTHROPIC_API_KEY="sk-ant-..."
+export OPENAI_API_KEY="sk-..."
+export GROK_API_KEY="xai-..."
+export DASHSCOPE_API_KEY="sk-..."  # Qwen
+export ZAI_API_KEY="sk-..."
+export MISTRAL_API_KEY="..."
+```
 
-A modern, fast, and privacy-focused web interface for interacting with all your LLMs.
+### API Key Reference
 
-- **Offline & Private**: All data stored locally in SQLite
-- **Dark Mode**: Automatic or manual dark mode toggle
-- **Rich Markdown**: Full markdown support with syntax highlighting
-- **Search**: Quickly find past conversations
-- **Export/Import**: Backup and transfer chat histories
+| Provider | Environment Variable | Description |
+|----------|---------------------|-------------|
+| openrouter_free | `OPENROUTER_API_KEY` | OpenRouter FREE models |
+| groq | `GROQ_API_KEY` | Groq API key |
+| google_free | `GOOGLE_FREE_API_KEY` | Google FREE API key |
+| codestral | `CODESTRAL_API_KEY` | Codestral API key |
+| ollama | N/A | No API key required |
+| openrouter | `OPENROUTER_API_KEY` | OpenRouter API key |
+| google | `GOOGLE_API_KEY` | Google API key |
+| anthropic | `ANTHROPIC_API_KEY` | Anthropic API key |
+| openai | `OPENAI_API_KEY` | OpenAI API key |
+| grok | `GROK_API_KEY` | Grok (X.AI) API key |
+| qwen | `DASHSCOPE_API_KEY` | Qwen (Alibaba) key |
+| z.ai | `ZAI_API_KEY` | Z.ai API key |
+| mistral | `MISTRAL_API_KEY` | Mistral API key |
 
-[Learn more about the Web UI →](/docs/features/web-ui)
+## Verification
 
-### 🖥️ CLI Interface
+After installation, verify it's working:
 
-- Interactive command-line tool
-- Support for all modalities (text, image, audio, files)
-- Custom system prompts
-- Raw JSON output mode
+<ShellCommand>llms ls</ShellCommand>
 
-[Learn more about the CLI →](/docs/features/cli)
+## Updating
 
-### 🎯 Multimodal Support
+To update to the latest version:
 
-Process text, images, audio, and documents with capable models.
+<ShellCommand>pip install llms-py --upgrade</ShellCommand>
 
-- **Text Generation**: Chat completions with any supported model
-- **Vision Models**: Process images through vision-capable models (GPT-4V, Gemini Vision, etc.)
-- **Audio Processing**: Handle audio inputs through audio-capable models
-- **Document Processing**: Analyze PDFs and documents with capable models
-- **Drag & Drop**: Easy file attachments in the UI
+For Docker:
 
-[Learn more about Multimodal Support →](/docs/features/multimodal)
-
-### Flexible Deployment Options
-- **CLI Tool**: Interactive command-line interface for quick queries
-- **HTTP Server**: OpenAI-compatible server at `http://localhost:{PORT}/v1/chat/completions`
-- **Python Module**: Import and use programmatically in your applications
-- **ComfyUI Node**: Embed directly in ComfyUI workflows
-
-### Simple and Customizable
-- **Environment Variables**: Secure API key management
-- **Provider Management**: Easy enable/disable of providers
-- **Custom Models**: Define your own model aliases and mappings
-- **Unified Configuration**: Single [llms.json](https://github.com/ServiceStack/llms/blob/main/llms/llms.json) to configure all providers and models
-  - Custom model aliases and mappings
-  - Flexible chat templates
-  - Environment variable support
-
-[Learn more about Configuration →](docs/configuration)
-
-### 🌐 OpenAI-Compatible API
-
-- Drop-in replacement for OpenAI API
-- Works with any OpenAI-compatible client
-- Streaming support
-- Custom parameters
-
-### 📊 Analytics & Monitoring
-
-Track costs, usage, and performance across all providers.
-
-- **Cost Tracking**: Per-message, per-thread, and monthly cost analytics
-- **Token Metrics**: Input/output token tracking
-- **Activity Logs**: Detailed request history
-- **Provider Stats**: Response times and reliability metrics
-
-[Learn more about Analytics →](/docs/features/analytics)
-
-### 🔄 Intelligent Provider Routing
-
-Automatic failover and cost optimization across providers.
-
-- **Multi-Provider**: Support for 10+ provider types with 160+ models
-- **Auto-Failover**: If one provider fails, automatically try the next
-- **Cost Optimization**: Route to free/cheap providers first
-- **Model Mapping**: Unified model names across providers
-
-[Learn more about Providers →](/docs/features/providers)
-
-### 🔒 Security
-
-- Optional GitHub OAuth authentication
-- User access restrictions
-
-[Learn more about GitHub OAuth →](/docs/deployment/github-oauth)
-
----
-
-## Links
-
-- 📚 [GitHub Repository](https://github.com/ServiceStack/llms)
-- 📦 [PyPI Package](https://pypi.org/project/llms-py/)
-- 🔧 [Source Code](https://github.com/ServiceStack/llms)
+<ShellCommand>docker pull ghcr.io/servicestack/llms:latest</ShellCommand>

content/docs/getting-started/installation.mdx

@@ -3,7 +3,6 @@
   "defaultOpen": true,
   "pages": [
     "index",
-    "installation",
     "quick-start"
   ]
 }