Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.opper.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Agents

Use Opper as an inference provider for your agent framework, editor, or SDK of choice. All integrations give you access to the full Opper model catalog, including EU-hosted options via AWS EU, Evroc, and Berget.
One-command setup through the Opper CLI:
npx @opperai/cli launch [AGENT]

OpenCode

Terminal-based AI coding assistant

Vercel AI SDK

Use any Opper model with the Vercel AI SDK

OpenClaw

Personal AI assistant powered by pi

pi

Terminal coding agent with native Opper provider support

Hermes

Open-source terminal agent via custom OpenAI-compatible endpoint

Claude Code

Anthropic’s CLI, routed through Opper’s Anthropic-compatible gateway

Claude Desktop

Anthropic’s desktop app (chat + Code), routed through Opper’s gateway

Cursor

AI-powered code editor with rules support

Cline

VS Code extension with OpenAI-compatible providers

Continue.dev

Open-source AI assistant for VS Code and JetBrains

GitHub Copilot

Route Copilot Chat and Agent mode in VS Code through Opper

​
OpenCode

OpenCode is a terminal-based AI coding assistant. Quick start (no install): 
npx @opperai/cli launch opencode
The CLI writes the Opper provider block into ~/.config/opencode/opencode.json and starts OpenCode. To wire it manually instead: 
mkdir -p ~/.config/opencode
curl -o ~/.config/opencode/opencode.json https://raw.githubusercontent.com/opper-ai/setup/main/data/opencode.json
export OPPER_API_KEY=your-api-key

​
Vercel AI SDK

The Vercel AI SDK is a TypeScript toolkit for building AI-powered applications. Install the Opper provider package and pass any Opper model string to generateText, streamText, embed, or tool calls: 
npm install @opperai/ai-sdk-provider ai

import { opper } from '@opperai/ai-sdk-provider';
import { generateText } from 'ai';

const { text } = await generateText({
  model: opper('openai/gpt-4o'),
  prompt: 'Hello!',
});
Pass any Opper model string: opper('anthropic/claude-sonnet-4-5'), opper('google/gemini-2.0-flash'), opper('default'), etc. Session tracing: Wrap your model with opperSpan to group all calls in a conversation under a single trace in Opper: 
import { wrapLanguageModel, generateText } from 'ai';
import { opper, opperSpan } from '@opperai/ai-sdk-provider';

const { middleware, handle } = opperSpan({ name: 'my-chat-session' });

const model = wrapLanguageModel({
  model: opper('openai/gpt-4o'),
  middleware,
});

const { text } = await generateText({ model, prompt: 'Hello!' });
await handle.end(text); // closes the span

​
OpenClaw

OpenClaw is a personal AI assistant built on pi that runs on WhatsApp, Telegram, Discord, and other chat apps. Add Opper as a custom provider in ~/.openclaw/config.json: 
{
  "env": { "OPPER_API_KEY": "your-api-key" },
  "agents": {
    "defaults": {
      "model": { "primary": "opper/anthropic/claude-opus-4" }
    }
  },
  "models": {
    "providers": {
      "opper": {
        "baseUrl": "https://api.opper.ai/v3/compat",
        "apiKey": "${OPPER_API_KEY}",
        "api": "openai-completions",
        "models": [
          { "id": "anthropic/claude-opus-4", "name": "Claude Opus 4 (Opper)" },
          { "id": "anthropic/claude-sonnet-4-6", "name": "Claude Sonnet 4.6 (Opper)" },
          { "id": "evroc/kimi-k2.5", "name": "Kimi K2.5 EU (Opper/Evroc)" },
          { "id": "gcp/gemini-2.5-flash-eu", "name": "Gemini 2.5 Flash EU (Opper)" }
        ]
      }
    }
  }
}
  1. Switch models at any time:
openclaw models set opper/anthropic/claude-sonnet-4-6
Session span tracing is not available via this method — that requires the native pi extension. You get full model access with a single API key.

​
pi

pi is a terminal-based coding agent. Quick start (no install): 
npx @opperai/cli launch pi
The CLI adds an opper provider entry to ~/.pi/agent/models.json (idempotently, alongside any existing providers) and starts pi. For deeper integration — 260+ Opper models, automatic session span tracing, and 7 multimodal tools — install the @opperai/pi-provider package: 
pi install npm:@opperai/pi-provider
export OPPER_API_KEY=your-api-key
Then use /model inside pi to switch to any Opper model. You also get 7 multimodal tools registered directly in pi: image generation, image analysis, text-to-speech, speech-to-text, web search, web fetch, and embeddings. Load only the provider or only the tools: 
{
  "packages": [
    {
      "source": "npm:@opperai/pi-provider",
      "extensions": ["extensions/provider.ts", "extensions/tools.ts"]
    }
  ]
}
Optional environment variables:
VariableDescription
OPPER_AGENT_NAMEOverride the framework name sent in headers (default: pi-code)
PI_IMAGE_SAVE_MODEDefault image save mode: tmp, project, global, or custom

​
Hermes

Hermes is an open-source terminal agent by Nous Research. Quick start (no install): 
npx @opperai/cli launch hermes
The CLI uses an isolated HERMES_HOME=~/.opper/hermes-home/ so your real ~/.hermes/ is untouched. To wire it manually into your existing Hermes setup, add Opper as a custom provider in ~/.hermes/config.yaml: 
# Add your Opper API key
echo 'OPPER_API_KEY=your-api-key' >> ~/.hermes/.env

# ~/.hermes/config.yaml
model:
  provider: custom
  base_url: https://api.opper.ai/v3/compat
  default: anthropic/claude-opus-4.5

# Or as a named custom provider (lets you keep other providers alongside it):
custom_providers:
  - name: opper
    base_url: https://api.opper.ai/v3/compat
    key_env: OPPER_API_KEY
With the named provider approach, switch models mid-session: 
/model custom:opper:anthropic/claude-opus-4.5
/model custom:opper:google/gemini-2.5-flash

​
Claude Code

Claude Code is Anthropic’s CLI. Quick start (no install): 
npx @opperai/cli launch claude
The CLI sets ANTHROPIC_BASE_URL / ANTHROPIC_AUTH_TOKEN and starts Claude Code with traffic routed to Opper’s Anthropic-compatible endpoint. To wire it manually, export the variables in your shell, or add the same keys to .claude/settings.local.json under env: 
export ANTHROPIC_BASE_URL=https://api.opper.ai/v3/compat
export ANTHROPIC_AUTH_TOKEN=your-api-key
export ANTHROPIC_DEFAULT_SONNET_MODEL=anthropic/claude-sonnet-4.6
export ANTHROPIC_DEFAULT_HAIKU_MODEL=anthropic/claude-haiku-4.5
export ANTHROPIC_DEFAULT_OPUS_MODEL=anthropic/opus-4-6

​
Claude Desktop

Claude Desktop is Anthropic’s macOS / Windows desktop app. Both the chat and Claude Code surfaces inside the app run through whichever inference profile is active. Quick start (no install): 
npx @opperai/cli launch claude-desktop
The CLI uses Claude Desktop’s documented third-party-inference mode (deploymentMode: "3p"): it writes an Opper profile to ~/Library/Application Support/Claude-3p/configLibrary/ on macOS (or %LOCALAPPDATA%\Claude-3p\configLibrary\ on Windows), pointing at Opper’s Anthropic-compatible endpoint. If Claude Desktop is already running, it is quit and reopened so the change takes effect immediately. The picker shows Opus, Sonnet, and Haiku with Opus 4.7 as the default; pass --model <id> to pin a different default. To revert Claude Desktop to standard Anthropic inference: 
npx @opperai/cli agents uninstall claude-desktop
This flips deploymentMode back to "1p" and removes the Opper profile entry. Other tools’ third-party profiles and your own preferences are left untouched.
On first launch, macOS will prompt “opper would like to control Claude” — accept this so the CLI can quit and reopen the app cleanly. Available on macOS and Windows; Anthropic does not ship a Linux build of Claude Desktop.

​
Cursor

Cursor is an AI-powered code editor. Download the Opper rules file for your language and drop it in your project to give Cursor context about the Opper SDKs.
  1. Download the .mdc file for your language:
  2. Place it in your project at .cursor/rules/opper.mdc.
  3. In Cursor, make sure the rule is set to Always.

​
Cline

Cline is an AI coding agent for VS Code. Add Opper as a provider in the Cline settings panel:
  1. Select OpenAI Compatible as the API Provider.
  2. Set the Base URL to https://api.opper.ai/v2/openai.
  3. Enter your Opper API key.
  4. Set the Model ID to any model available on Opper (e.g. gcp/gemini-2.5-flash-eu).

​
Continue.dev

Continue.dev is an open-source AI code assistant for VS Code and JetBrains. Add Opper manually to ~/.continue/config.yaml: 
models:
  - name: Gemini 2.5 Flash (EU)
    provider: openai
    model: gcp/gemini-2.5-flash-eu
    apiKey: your-api-key
    apiBase: https://api.opper.ai/v2/openai
    roles:
      - chat
      - edit

​
GitHub Copilot

GitHub Copilot Chat and Agent mode in VS Code can be routed through Opper via the OAI Compatible Provider extension. Inline completions stay on GitHub’s own service. Quick start (no install): 
npx @opperai/cli editors github-copilot-vscode
The CLI prompts before installing the community extension, then writes the Opper provider block into your VS Code user settings.json. Reload the window, then in Copilot Chat: model picker → Manage Models → OAI Compatible → paste your OPPER_API_KEY when prompted. To wire it manually instead:
  1. Install the extension: code --install-extension johnny-zhao.oai-compatible-copilot
  2. Add Opper to your VS Code user settings.json: 
    "oaicopilot.baseUrl": "https://api.opper.ai/v3/compat",
"oaicopilot.models": [
  {
    "id": "anthropic/claude-opus-4.5",
    "owned_by": "opper",
    "apiMode": "openai",
    "context_length": 1000000
  }
]
  3. Open Copilot Chat → model picker → Manage Models → OAI Compatible → paste your Opper API key when prompted.
Copilot Business / Enterprise users may need their org admin to enable the “Bring Your Own Language Model Key in VS Code” policy.

​
Developer Tools

For terminal use of Opper itself, see the CLI. For dropping Opper context into AI code editors (Claude Code, Cursor, Cline, GitHub Copilot, OpenAI Codex, Windsurf), see Skills.