Repository navigation
Expand file tree
/
Copy pathllms.txt
More file actions
77 lines (60 loc) · 5.04 KB
/
Copy pathllms.txt
File metadata and controls
77 lines (60 loc) · 5.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# Grob
> High-performance LLM routing proxy written in Rust. Routes requests to Anthropic, OpenAI, Gemini, DeepSeek, Ollama, and 200+ models via OpenRouter with automatic failover, format translation between Anthropic and OpenAI APIs, streaming support, tool calling, DLP scanning, spend tracking, and budget enforcement.
## Guides
- [Getting Started](docs/tutorials/getting-started.md): Install to running, with a three-command path at the top
- [Provider Setup](docs/how-to/providers.md): Per-provider configuration guides for all 13+ supported backends
- [OAuth Setup](docs/how-to/oauth-setup.md): OAuth authentication for Anthropic Pro/Max and Gemini Pro subscriptions
## Reference
- [Configuration Reference](docs/reference/configuration.md): All TOML config options with defaults and examples
- [CLI Reference](docs/reference/cli.md): All CLI commands and flags
- [API Compatibility](docs/reference/api-compatibility.md): `/v1/messages`, `/v1/chat/completions`, and `/v1/responses` — supported features, translation, and limitations
- [OpenAPI Specification](docs/openapi.yaml): Full API reference in OpenAPI 3.0 format
- [Error Reference](docs/reference/errors.md): HTTP status codes and error types
- [Provider Reference](docs/reference/providers.md): Provider trait, implementations, format translation, streaming, and error types
- [Troubleshooting](docs/how-to/troubleshooting.md): Common errors, diagnostics, and fixes
## How-to
- [How to Configure Grob](docs/how-to/configure.md): Budgets, fallbacks, routing rules, tracing
- [How to Deploy Grob](docs/how-to/deploy.md): Container, Kubernetes, systemd deployment
- [How to Contribute](docs/how-to/contribute.md): Development workflow, code style, CI
## Architecture
- [Architecture Overview](docs/explanation/architecture.md): Request flow, module layout, and key design decisions
- [Design Principles](docs/explanation/design-principles.md): Philosophy, writing principles, and UX guidelines
- [Security Model](docs/explanation/security.md): Threat model, defense layers, TLS, audit logging
- [Gemini Integration](docs/how-to/gemini-integration.md): Gemini and Vertex AI provider specifics
## Decisions
- [ADR-0001: Static config](docs/decisions/0001-static-config-no-hot-reload.md): Why no hot reload
- [ADR-0002: Custom OAuth](docs/decisions/0002-custom-oauth-no-crate.md): Why no oauth2 crate
- [ADR-0003: Regex routing](docs/decisions/0003-regex-routing-engine.md): Why regex-based routing
- [ADR-0004: Persistent spend](docs/decisions/0004-persistent-spend-tracking.md): Persistent spend tracking (superseded by ADR-0013)
- [ADR-0005: Anthropic-native trait](docs/decisions/0005-anthropic-native-provider-trait.md): Why Anthropic as the internal format
## Source
- [Entry point](src/main.rs): CLI argument parsing and command dispatch
- [Library root](src/lib.rs): Module declarations
- [Trait contracts](src/traits.rs): the two genuinely polymorphic abstractions (Tracer, ProviderAvailability). Provider backends use LlmProvider in src/providers/mod.rs
- [Request extensions](src/models/extensions.rs): Provider-specific fields for lossless OpenAI roundtrips
- [Provider trait](src/providers/mod.rs): LlmProvider trait definition and provider types
- [Router](src/routing/classify/mod.rs): Regex-based request classification and model selection (post T-VS)
- [Dispatch pipeline](src/server/dispatch/mod.rs): DLP, cache, routing, provider loop with fallback
- [Provider loop](src/server/dispatch/provider_loop.rs): Fallback/retry logic per mapping
- [Server](src/server/mod.rs): Axum HTTP server, middleware stack, and application state
- [CLI config](src/cli/mod.rs): AppConfig and all configuration structs
- [Config structs](src/cli/config/): ServerConfig, SecurityConfig, RouterConfig, ProviderConfig, and the rest
- [Commands](src/commands/mod.rs): CLI command implementations
- [Storage](src/storage/mod.rs): Atomic files + JSONL journals backend (GrobStore), AES-256-GCM at rest
- [Spend tracking](src/features/token_pricing/spend.rs): Monthly spend with budget enforcement
- [DLP engine](src/features/dlp/mod.rs): Secret/PII scanning with Aho-Corasick
- [MCP tool matrix](src/features/mcp/mod.rs): Tool-calling capability catalogue and scoring
- [Harness](src/features/harness/mod.rs): Record & replay sandwich testing (tape capture, mock backend, driver)
## Configuration
- [Configuration Reference](docs/reference/configuration.md): All TOML options
- [Example configs](docs/examples/): Sample configurations for common setups
- [Presets](presets/): Built-in preset configurations (perf, ultra-cheap, eu-eco, eu-pro, eu-max, gdpr, eu-ai-act)
## Project
- [README](README.md): Project overview, install, quick start
- [Changelog](CHANGELOG.md): Release history
- [License](LICENSE): Apache-2.0
- [Licensing](LICENSING.md): Apache-2.0 core and commercial product options
- [Contributing](CONTRIBUTING.md): How to contribute (redirect to full guide)
- [CLA](CLA.md): Contributor License Agreement
- [AI Agent Context](AGENTS.md): Project context optimized for AI coding agents
- [Development Guidelines](CLAUDE.md): Code style, doc comment conventions, module layout