llmadapter

llmadapter Documentation

This directory contains the detailed user, operator, library, and provider-development documentation for llmadapter.

The root README.md is the public landing page. This file is the documentation index.

When GitHub Pages is enabled for this repository, the docs workflow publishes this directory and uses this file as the site index.

Getting Started: fresh checkout, credentials, CLI inference, config inspection, gateway, Docker, and live smoke tests.
CLI: command reference for providers, routes, models, resolve, infer, proxy, serve, smoke, compatibility-record, and conformance.
Configuration: JSON config, provider instances, endpoint routes, dynamic models, modeldb, capabilities, pricing, and fallback behavior.
Library Usage: Go client patterns, direct provider clients, mux client construction, tool loops, prompt caching, diagnostics, quotas, and provider extensions.

Provider Matrix: supported provider endpoint types, API kinds/families, continuation behavior, transport behavior, feature coverage, and live smoke commands.
Use Case Matrix: workload-specific compatibility evidence, including agentic-coding approval rows.
API Surface: stable public packages, extension packages, internal packages, and v1 package-boundary rules.

Troubleshooting: WebSocket closures, context-window surprises, transport-mode debugging, and provider error triage.
Architecture: practical architecture review of request flow, endpoint codecs, routing, mux/gateway behavior, continuation boundaries, transports, and known shortcomings.

Provider Development: how to add provider endpoints, model API kinds/families, update registry/config behavior, and add shared smoke coverage.

examples/README.md: shipped config examples and adaptation notes.
examples/llmadapter.example.json: multi-provider gateway/mux config.
examples/modeldb.overlay.example.json: modeldb overlay example used by the main config.

Local checks:

env GOCACHE=/tmp/go-cache go test ./...
env GOCACHE=/tmp/go-cache go vet ./...
env GOCACHE=/tmp/go-cache GOMODCACHE=/tmp/go-mod-cache go build ./...

Live provider matrix:

env GOCACHE=/tmp/go-cache TEST_INTEGRATION=1 go test ./tests/e2e -count=1 -v