Files
OmniRoute/docs/i18n/de/CLAUDE.md
Diego Rodrigues de Sa e Souza f59f8daa94 Release v3.8.6 (#2804)
* fix(gemini): preserve structured tool calls for antigravity

* fix(gemini): parse prefixed textual tool calls

* fix(antigravity): preserve textual SSE tool calls

* fix(stream): normalize textual passthrough tool calls

* fix(stream): normalize split textual tool calls

* fix(stream): suppress malformed textual tool calls

* fix(stream): suppress compact malformed tool calls

* fix(stream): emit structured textual tool calls

* fix(stream): suppress unknown textual tool calls

* fix(stream): normalize responses textual tool calls

* chore: ignore .claude/settings.local.json (per-user Claude Code permissions)

* fix(opencode-go): route qwen3.x via claude messages + repair fixMissingToolResponses for Claude-shape upstreams (#2791)

Integrated into release/v3.8.6

* fix: resolve npm install warnings — remove dead deps, relax engine constraint (#2792)

Integrated into release/v3.8.6

* fix: register missing web-cookie validators (claude-web, gemini-web, copilot-web, t3-web) (#2793)

Integrated into release/v3.8.6

* fix: Error: Unable to inspect existing database #2771 (#2795)

Integrated into release/v3.8.6

* fix(oauth): repair Google loopback callback flow (#2796)

Integrated into release/v3.8.6

* feat(logs): add clean history button (#2799)

Integrated into release/v3.8.6

* [codex] home: restore settings-driven home layout and quota auto-refresh (#2800)

Integrated into release/v3.8.6

* fix(gemini): emit signaturelessToolCallMode:text for GEMINI format models (#2801)

Integrated into release/v3.8.6

* feat(modelSpecs): align opencode-go family with upstream provider limits (#2802)

Integrated into release/v3.8.6

* chore: apply unit test fixes, polyfills, and environment precedence fixes

* docs(agents): atualiza fluxos de release e triagem

Expande os workflows de release para incluir auditoria de segurança,
CHANGELOG completo por commits, quality gate obrigatório, homologação em
VPS local, publicação oficial, deploy em Akamai e validação de artefatos.

Reorganiza a triagem de features com arquivos permanentes por bucket,
suporte a itens em andamento, regra de reclaim após 15 dias e novo
tratamento para ideias viáveis catalogadas.

Corrige a orientação de revisão de discussões para usar a ordem
cronológica real dos comentários e respostas ao identificar a última
atividade.

* fix(lockout): classify Gemini Antigravity resource exhaustion as quota_exhausted

* fix(reasoning): gate replay by interleaved field

* docs(rule-16): permit human Co-authored-by, restrict only AI/bot trailers

Rule #16 previously banned all `Co-Authored-By` trailers absolutely.
That blocked the upstream-port workflows (`/port-upstream-features` and
`/port-upstream-issues`), which must credit human upstream PR authors
and issue reporters in OmniRoute commits.

Refine the rule to ban only AI/bot-attributed trailers (Claude, GPT,
Copilot, Bot; anthropic.com / openai.com / bot-owned noreply.github.com
emails) while allowing standard human `Co-authored-by: Name <email>`
attribution.

Sync the rule across the source CLAUDE.md, the E2E shakedown doc note,
and 41 i18n translations.

* fix(gitlawb): add specialty validators for connection test — bypass /models probe

GitLawB OpenGateway API (xiaomi-mimo compatible) does not expose a /models
endpoint, causing validateOpenAILikeProvider to 404 on the initial probe
and report 'Provider validation endpoint not supported'.

Add specialty validators for both gitlawb and gitlawb-gmi that follow the
same pattern as the existing xiaomi-mimo validator: skip GET /models,
validate directly via POST /chat/completions with a minimal test message.
Any 401/403 response means an invalid key; all other responses mean auth
is OK.

Fixes test-connection returning 404 for GitLawB providers.

* test(gitlawb): add 12 unit tests for gitlawb and gitlawb-gmi specialty validators

Covers success, auth failure (401/403), non-auth acceptance (400/422/429),
network errors, and custom baseUrl overrides for both providers.

* feat(gitlawb): serve models from static registry without API-unavailable warning

GitLawB's OpenGateway API does not expose a /models endpoint per
provider-path. Previously the models route fell through to the generic
fallback which returned static catalog models with the misleading
'API unavailable — using local catalog' warning.

Now gitlawb and gitlawb-gmi are handled as static model providers
(same pattern as reka and qwen OAuth) — models are served from the
provider registry without any warning, since all registered models
are functional via POST /chat/completions.

* refactor(gitlawb): extract shared opengateway validator factory, fix docs path in test

- Extract gitlawb/gitlawb-gmi validators into buildOpengatewayValidator factory
- Fix dockerignore-docs-coverage test: update stale docs/AUTO-COMBO.md -> docs/routing/AUTO-COMBO.md

* fix(reasoning): guard interleaved capability lookup

* feat(gitlawb): dynamic model fetch with gmi-cloud fallback

Hybrid approach:
- gitlawb (xiaomi-mimo): dynamic /models endpoint → 356 models
- gitlawb-gmi (gmi-cloud): 404 fallback → local catalog gracefully
Mimics Gitlawb/openclaude's model-routing pattern

* i18n(pt-BR): complete missing translations and sync with en.json

* feat(build): nix multi-OS package manager install (#2806)

Integrated into release/v3.8.6

* fix(i18n): translate 144 new __MISSING__ pt-BR strings (#2816)

Integrated into release/v3.8.6

* chore(docs): set coverage gate to 40/40/40/40 in CLAUDE.md

Aligns the documented coverage gate with the v3.8.6 release decision
(lowered from 75/75/75/70). Matches the threshold already set in
package.json by the large feature PRs (planos 11-22).

* fix(cli): respect PORT env var in serve command (#2845)

Integrated into release/v3.8.6.

* fix(deepseek-web): return 400 when client sends tools[] - chat.deepseek.com has no tool support (#2854)

Integrated into release/v3.8.6.

* fix(qoder): reject invalid/expired PATs returning Cosy 500 error (#2860)

Integrated into release/v3.8.6.

* fix(cli): register openclaw in tool-detector (#2833) (#2850)

Integrated into release/v3.8.6.

* fix(api): include noAuth providers in /v1/models catalog (#2798) (#2814)

Integrated into release/v3.8.6.

* fix(combo): resolve custom provider targets via combo name (#2778) (#2812)

Integrated into release/v3.8.6.

* fix(translator): strip safety_identifier in openai-responses cleanup (#2770) (#2809)

Integrated into release/v3.8.6.

* fix(quota): honor explicit per-connection preflight opt-out (#2831) (#2844)

Integrated into release/v3.8.6.

* fix(usage): un-invert GitHub Copilot Free/limited quota — limited_user_quotas is remaining (#2876) (#2881)

Integrated into release/v3.8.6.

* fix(nous-research): correct baseUrl to include /chat/completions (#2826) (#2835)

Integrated into release/v3.8.6.

* fix(opencode): qwen3.x max/plus models lack vision support (#2822) (#2836)

Integrated into release/v3.8.6.

* fix(translator): pass-through tool_search built-in tool type (#2766) (#2811)

Integrated into release/v3.8.6.

* fix(github): route claude-opus-4.6 via chat completions (#2821)

Integrated into release/v3.8.6.

* docs(oauth): add Windsurf login fix design (Phase 1 hotfix + Phase 2 Firebase OAuth)

Two-phase plan to fix the broken Windsurf OAuth flow:
- Phase 1: drop the dead app.devin.ai/editor/signin PKCE path, promote
  import-token from windsurf.com/show-auth-token as the primary path
- Phase 2: port Firebase OAuth + RegisterUser flow from
  fendoushaonian/WindSurf-gRPC-API for full browser-based automation

Spec only - no code changes yet.

* docs(plan): Phase 1 windsurf login hotfix implementation plan

10 tasks covering:
- TDD assertions for flowType + 410 Gone responses
- Provider switch to import_token
- Route handler retiring authorize/start-callback-server/poll-callback
- OAuthModal UI override
- i18n sync
- Verification + PR steps

* fix(cli): replace cli-table3 with hand-rolled formatter (#2752) (#2813)

Integrated into release/v3.8.6.

* fix(skills): skip interception for unregistered client-native tools (#2815) (#2817)

Integrated into release/v3.8.6.

* feat(sse): add RTK filters for kubectl, docker-build, composer, gh (#2824)

Integrated into release/v3.8.6.

* fix(geminiHelper): support rec.image content shape + warn on dropped remote URLs (refs #2807) (#2855)

Integrated into release/v3.8.6.

* fix(cli): allow nullable/optional apiKey in cliMitmStartSchema (#2857)

Integrated into release/v3.8.6.

* fix(combo): preserve system messages during context handoff summary generation (#2865)

Integrated into release/v3.8.6.

* fix: wire CLIProxyAPI fallback settings into chatCore routing engine (#2866)

Integrated into release/v3.8.6.

* fix(usage): add opencode quota fetcher (#2852) (#2867)

Integrated into release/v3.8.6.

* feat(claude): default xhigh support for newer Opus models (#2874)

Integrated into release/v3.8.6.

* fix(cli): restore omniroute logs command stream (#2756) (#2810)

Integrated into release/v3.8.6.

* fix(combo): normalize upstream Headers for Node 24 undici interop (#2751) (#2823)

Integrated into release/v3.8.6.

* Rename proxy log Public IP to Client IP (#2880)

Integrated into release/v3.8.6.

* fix(claude): preserve max effort for supported models (#2875)

Integrated into release/v3.8.6.

* fix(oauth): switch windsurf provider to import_token flow

The PKCE auth URL targeting app.devin.ai/editor/signin returns 404
post-rebrand. Until Phase 2 ports Firebase OAuth + RegisterUser, the
only supported path is import-token via windsurf.com/show-auth-token.

- windsurf.ts: drop buildAuthUrl, set flowType=import_token
- generateAuthData returns supported:false + helpful error for windsurf/devin-cli
- tests: assert flowType + disabled stub

* fix(oauth): return 410 Gone for retired windsurf/devin-cli PKCE actions

start-callback-server, authorize, and poll-callback (GET + POST) now
return 410 Gone with a pointer to /import-token. The 410 short-circuit
runs before auth so the response is honest about the action being
permanently gone, not gated. Codex PKCE flow unchanged.

Tests: 5 new assertions cover GET + POST 410 paths and a Codex
regression check.

* refactor(oauth): annotate retired PKCE fields in WINDSURF_CONFIG

No behaviour change - comment-only update documenting that authorizeUrl,
codeChallengeMethod, callbackPort, callbackPath, apiServerUrl, and
exchangePath are no longer consumed. Active fields (inferenceUrl,
showAuthTokenUrl, firebaseApiKey, ideName) called out separately.

* fix(cli,docs): use requireCliToolsAuth in logs route + document OPENCODE quota env

Post-merge contract fixes for v3.8.6:
- src/app/api/cli-tools/logs/route.ts (#2810) now uses the shared
  requireCliToolsAuth guard (param renamed req->request) to satisfy the
  cli-tools-auth-hardening contract test.
- Document OMNIROUTE_OPENCODE_QUOTA_URL (#2867) in docs/reference/ENVIRONMENT.md
  to satisfy the env/docs sync contract.

* fix(dashboard): force import-token panel for windsurf/devin-cli

Phase 1 hotfix: hide the 'Browser Login' tab and start in Paste API Key
mode. Removes windsurf/devin-cli from PKCE_CALLBACK_SERVER_PROVIDERS so
no callback server is started for them. Codex still uses the PKCE flow.

The 'Get token' link continues to point at windsurf.com/show-auth-token
via the existing supportsTokenPaste form copy.

* fix(oauth): windsurf import-token mapTokens signature mismatch

The route at `src/app/api/oauth/[provider]/[action]/route.ts` invokes
`providerData.mapTokens({ accessToken: token })` (object), matching the
cursor/kiro signature. The windsurf provider was declared with
`mapTokens(token: string)` instead, so the entire object was stored as
`accessToken`. When the connection record reached the SQLite layer it
crashed with:

  SQLite3 can only bind numbers, strings, bigints, buffers, and null

Fix by aligning windsurf's `mapTokens` signature with the route caller
and the cursor/kiro convention. Also dedupe a copy-pasted second
`if (action === "import-token")` block in the route handler — the
second block was unreachable but identical to the first.

Adds two regression tests asserting that
`provider.mapTokens({ accessToken })` returns a string `accessToken` for
both windsurf and devin-cli, so a future signature drift trips the gate
instead of the SQLite bind error in production.

* feat(compression): expand pt-BR pack with troglodita rules (15 → 49) (#2818)

Integrated into release/v3.8.6

* fix(sse): repair RTK engine defaults so dedup and direct calls work (#2825)

Integrated into release/v3.8.6

* fix(mcp): redirect console.log/warn to stderr in --mcp stdio mode (#2840)

Integrated into release/v3.8.6

* fix(gemini-cli): prefer real project IDs over default-project (#2841)

Integrated into release/v3.8.6

* fix(opencode-go): add provider limits quota fetcher (#2861)

Integrated into release/v3.8.6

* Audit & add web cookie providers: fix 4 missing registry entries + DuckDuckGo (#2862)

Integrated into release/v3.8.6

* fix(antigravity): harden signatureless tool history (#2878)

Integrated into release/v3.8.6

* fix: provider model sync pruning and dynamic antigravity MITM proxy mappings (#2886)

Integrated into release/v3.8.6

* feat(usage): per-API-key token limits scoped to model/provider/global (#2888)

Integrated into release/v3.8.6

* fix(audio): build multipart body manually to preserve Content-Type (#2842)

Integrated into release/v3.8.6

* refactor: remove agent skill documentation files and streamline maintenance workflows

* test(stabilization): resolve unit test failures in blackbox-web, schema-coercion, translator-helper-branches, usage-service-hardening, and audio-transcription

* fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) (#2871)

Two real security gaps closed and four cosmetic Socket.dev fingerprints removed.
See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer
attestation.

Real bugs fixed:
- cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in
  `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` /
  `refreshToken` / `providerSpecificData` from a remote response. Closes the
  silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could
  previously replace local tokens unverified).
- Zed import: split into 2-step `/discover` + `/import` flow. `/import` now
  requires `confirmedAccounts: [{ service, account, fingerprint }]` and
  re-reads the keychain server-side to filter by fingerprint, so a tampered
  discover response cannot trick the endpoint into saving an unrelated token.

Cosmetic Socket.dev mitigations:
- runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1`
  file (mode 0o600) and references it via `-File`. Removes the textbook
  `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI
  classifier.
- Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every
  flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`.

Build-time hardening:
- `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically
  removes the four sensitive modules from the standalone bundle via webpack
  `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at
  runtime. Intended for the `omniroute-secure` artifact.

Tests:
- 24 new unit tests in `tests/unit/security/` covering the wrapper builder,
  HMAC verification (4 cases), credential fingerprint determinism (5 cases),
  confirmedAccounts validation + fingerprint filtering (6 cases), and the
  minimal-build stubs (5 cases).

Docs:
- New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation.
- New `socket.yml` — Socket.dev v2 config pointing at the attestation.
- Updated `SECURITY.md` — supply-chain scanner section.
- Updated `.env.example` — three new env vars documented.

Backwards compatibility:
- Cloud sync token overwrite is OFF by default. Users who relied on
  it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented
  in CHANGELOG.
- Zed import 2-step is the new default; legacy 1-step preserved behind
  `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9.

Closes #2863

* fix(security): redact public Firebase Web key from windsurf spec; doc SHA-256 cache-key rationale (#2894)

Two security-scanning findings on release/v3.8.6:

- Secret-scanning alert 7 (google_api_key): the windsurf login-fix design spec
  embedded the literal public Firebase Web API key on two lines. Firebase Web
  API keys are non-sensitive by design (they identify the project; access is
  gated by Firebase Security Rules + key restrictions), but the literal trips
  secret scanning. Redacted to a placeholder; the embedded default still goes
  through resolvePublicCred per rule #11.

- Code-scanning alert 261 (js/insufficient-password-hash): tokenCacheKey() uses
  SHA-256 to derive an in-memory cache key from the session token, not for
  password-at-rest storage. Added a comment documenting why CWE-916 KDFs do not
  apply (false positive).

* fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) (#2895)

* fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact)

Three CI gates failed on release/v3.8.6 (run 26630300877):

- docs-sync: CHANGELOG had a spurious "## [3.8.6-patch]" section above
  "## [3.8.6]", so the latest release no longer matched package.json (3.8.6)
  and the 41 i18n CHANGELOG mirrors were flagged as missing that section.
  Fold the lone #2752 entry into [3.8.6] and drop the patch heading.
- any-budget:t11: open-sse/handlers/chatCore.ts regressed to 1 explicit `any`
  (budget 0). Type the persist callback arg as Record<string, unknown>, which
  matches runWithOnPersist's RefreshPersistFn contract exactly.
- pack-artifact: open-sse/utils/setupPolyfill.ts ships via package.json "files"
  (bin/omniroute.mjs imports it at startup) but was missing from the pack
  policy allowlist. Allow it and add a regression test.

* fix(security): redact public Firebase Web key from windsurf spec

Redact the literal public Firebase Web API key (secret-scanning #7) to a
placeholder, mirroring the redaction on release/v3.8.6 (PR #2894) and the
windsurf fix branch. Non-sensitive public Web key; trips secret scanning.

* feat(combo): Zero-Latency Combos (Hedging, Proactive Compression, Predictive TTFT) (#2868)

* feat(combo): implement zero-latency combo optimizations (hedging, proactive compression, predictive TTFT)

* fix(combo): fix predictive TTFT skip logic and unhandled promise rejections

---------

Co-authored-by: Automation <automation@omniroute>

* feat: implement automated skill workflows and update system configuration and validation schemas

* test: eliminate dynamic cast warnings in cloud-sync unit test

* test: isolate services-branch-hardening database directory to avoid concurrency issues

* feat(providers): add 7 new web-cookie providers + research catalog + discovery tool

New providers:
- huggingchat: free LLM chat via huggingface.co/chat (no subscription)
- phind: free dev-focused AI chat via phind.com/api/agent
- poe-web: multi-model chat via poe.com GraphQL (p-b cookie)
- venice-web: privacy-focused AI chat via venice.ai (session cookie)
- v0-vercel-web: Vercel v0 code gen via v0.dev (session cookie)
- kimi-web: Moonshot Kimi chat via kimi.moonshot.cn (session cookie)
- doubao-web: ByteDance Doubao chat via doubao.com (session cookie)

Additional:
- Research catalog: docs/research/UNLIMITED_LLM_ACCESS.md
- Discovery tool design + stub: src/lib/discovery/ + migration 073
- Unit tests: 33 tests for all 7 providers
- Shared helpers consolidated in error.ts (slop cleanup)
- All registered in WEB_COOKIE_PROVIDERS + providerRegistry + webSessionCredentials

Closes #2885

* fix(typecheck): resolve typecheck errors in combo spec and compression modules

* feat(api,oauth): add `agy` (Antigravity CLI) standalone provider with CLI token import (#2899)

Add a standalone OAuth provider `agy` (Antigravity CLI) next to gemini-cli/antigravity.
It reuses the antigravity inference backend (identical Google client_id +
daily-cloudcode-pa.googleapis.com endpoint, executor and token-refresh) but ships its own
model catalog — including the Claude models the backend exposes (claude-opus-4-6-thinking,
claude-sonnet-4-6) — its own account pool, and four ways to connect:

- token-file import (paste/upload the agy oauth token JSON)
- auto-detect a local CLI login (~/.gemini/antigravity-cli/antigravity-oauth-token)
- browser OAuth (via the shared OAuthModal Google loopback flow)
- bulk / ZIP import

New routes: POST /api/providers/agy-auth/{import,import-bulk,zip-extract,apply-local}.
Catalog pinned from the live :fetchAvailableModels endpoint. Docs (openapi.yaml,
ENVIRONMENT.md, .env.example, CHANGELOG) updated; new unit tests for registration,
the token parser, and route auth-hardening.

* fix(security): redact public Firebase Web key from windsurf spec (#2896)

Redact the literal public Firebase Web API key (secret-scanning #7) to a
placeholder. Firebase Web API keys are non-sensitive by design but the literal
trips GitHub secret scanning. Mirrors the redaction landed on release/v3.8.6
(PR #2894). Embedded default still flows through resolvePublicCred (rule #11).

* Pr 2871 (#2897)

* fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863)

Two real security gaps closed and four cosmetic Socket.dev fingerprints removed.
See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer
attestation.

Real bugs fixed:
- cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in
  `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` /
  `refreshToken` / `providerSpecificData` from a remote response. Closes the
  silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could
  previously replace local tokens unverified).
- Zed import: split into 2-step `/discover` + `/import` flow. `/import` now
  requires `confirmedAccounts: [{ service, account, fingerprint }]` and
  re-reads the keychain server-side to filter by fingerprint, so a tampered
  discover response cannot trick the endpoint into saving an unrelated token.

Cosmetic Socket.dev mitigations:
- runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1`
  file (mode 0o600) and references it via `-File`. Removes the textbook
  `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI
  classifier.
- Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every
  flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`.

Build-time hardening:
- `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically
  removes the four sensitive modules from the standalone bundle via webpack
  `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at
  runtime. Intended for the `omniroute-secure` artifact.

Tests:
- 24 new unit tests in `tests/unit/security/` covering the wrapper builder,
  HMAC verification (4 cases), credential fingerprint determinism (5 cases),
  confirmedAccounts validation + fingerprint filtering (6 cases), and the
  minimal-build stubs (5 cases).

Docs:
- New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation.
- New `socket.yml` — Socket.dev v2 config pointing at the attestation.
- Updated `SECURITY.md` — supply-chain scanner section.
- Updated `.env.example` — three new env vars documented.

Backwards compatibility:
- Cloud sync token overwrite is OFF by default. Users who relied on
  it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented
  in CHANGELOG.
- Zed import 2-step is the new default; legacy 1-step preserved behind
  `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9.

Closes #2863

* feat: implement automated skill workflows and update system configuration and validation schemas

* test: eliminate dynamic cast warnings in cloud-sync unit test

* test: isolate services-branch-hardening database directory to avoid concurrency issues

* chore(docs): refresh generated docs collection index

Update the generated Fumadocs browser collection mapping to keep
documentation imports in sync with the current docs structure.

* docs: update generated browser docs collection manifest

Refresh the generated Fumadocs browser collection mapping so the docs site can resolve the current documentation files correctly.

---------

Co-authored-by: OpenClaw <openclaw@kuzhomesrv.local>
Co-authored-by: Dmitry Kuznetsov <139351986+dmitry@users.noreply.local>
Co-authored-by: KuzyaBot <kuzya@local>
Co-authored-by: JeferssonLemes <jeferssondev@gmail.com>
Co-authored-by: Paijo <14921983+oyi77@users.noreply.github.com>
Co-authored-by: Markus Hartung <mail@hartmark.se>
Co-authored-by: akarray <akarray@users.noreply.github.com>
Co-authored-by: Apostol Apostolov <theapoapostolov@gmail.com>
Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com>
Co-authored-by: Dmitry Kuznetsov <dmitry@kuznetsov.me>
Co-authored-by: Nikolay Alafuzov <alafuzov_nn@rusklimat.ru>
Co-authored-by: oyi77 <oyi77@users.noreply.github.com>
Co-authored-by: Ronaldo Davi <alltomatos@users.noreply.github.com>
Co-authored-by: levonk <277861+levonk@users.noreply.github.com>
Co-authored-by: Lenine Júnior <lenine@engrene.com.br>
Co-authored-by: Annas Alghoffar <aag.annas@gmail.com>
Co-authored-by: Tushar Agarwal <76201310+Tushar49@users.noreply.github.com>
Co-authored-by: GreatLiu <eurasiaxz@qq.com>
Co-authored-by: yuna amelia <230527278+yunaamelia@users.noreply.github.com>
Co-authored-by: Randi <55005611+rdself@users.noreply.github.com>
Co-authored-by: Container <78986709+disonjer@users.noreply.github.com>
Co-authored-by: nickwizard <35692452+nickwizard@users.noreply.github.com>
Co-authored-by: Rajvardhan Patil <rajvardhanpatil7890@gmail.com>
Co-authored-by: Raxxoor <manker_lol@hotmail.com>
Co-authored-by: Muhammad Mugni Hadi <mugnimaestra3@gmail.com>
Co-authored-by: mi <123757457+soyelmismo@users.noreply.github.com>
Co-authored-by: Automation <automation@omniroute>
2026-05-29 12:44:29 -03:00

28 KiB

CLAUDE.md (Deutsch)

🌐 Languages: 🇺🇸 English · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇪🇸 es · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇳 gu · 🇮🇱 he · 🇮🇳 hi · 🇭🇺 hu · 🇮🇩 id · 🇮🇩 in · 🇮🇹 it · 🇯🇵 ja · 🇰🇷 ko · 🇮🇳 mr · 🇲🇾 ms · 🇳🇱 nl · 🇳🇴 no · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇸🇰 sk · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇻🇳 vi · 🇨🇳 zh-CN


Diese Datei bietet Anleitungen für Claude Code (claude.ai/code) beim Arbeiten mit Code in diesem Repository.

Schnellstart

npm install                    # Abhängigkeiten installieren (erstellt automatisch .env aus .env.example)
npm run dev                    # Entwicklungsserver unter http://localhost:20128
npm run build                  # Produktionsbuild (Next.js 16 standalone)
npm run lint                   # ESLint (0 Fehler erwartet; Warnungen sind bereits vorhanden)
npm run typecheck:core         # TypeScript-Überprüfung (sollte sauber sein)
npm run typecheck:noimplicit:core  # Strenge Überprüfung (kein implizites any)
npm run test:coverage          # Unit-Tests + Coverage-Gate (75/75/75/70 — Anweisungen/Zeilen/Funktionen/Zweige)
npm run check                  # lint + test kombiniert
npm run check:cycles           # Zirkuläre Abhängigkeiten erkennen

Tests Ausführen

# Einzelne Testdatei (Node.js nativer Test-Runner — die meisten Tests)
node --import tsx/esm --test tests/unit/your-file.test.ts

# Vitest (MCP-Server, autoCombo, Cache)
npm run test:vitest

# Alle Suiten
npm run test:all

Für die vollständige Testmatrix siehe CONTRIBUTING.md → "Tests Ausführen". Für die tiefere Architektur siehe AGENTS.md.


Projekt auf einen Blick

OmniRoute — einheitlicher KI-Proxy/Router. Ein Endpunkt, 160+ LLM-Anbieter, automatischer Fallback.

Schicht Standort Zweck
API-Routen src/app/api/v1/ Next.js App Router — Einstiegspunkte
Handler open-sse/handlers/ Anfrageverarbeitung (Chat, Embeddings usw.)
Executor open-sse/executors/ Anbieter-spezifische HTTP-Zustellung
Übersetzer open-sse/translator/ Formatkonvertierung (OpenAI↔Claude↔Gemini)
Transformator open-sse/transformer/ Antworten API ↔ Chat-Vervollständigungen
Dienste open-sse/services/ Kombinierte Routen, Ratenlimits, Caching usw.
Datenbank src/lib/db/ SQLite-Domain-Module (45+ Dateien, 55 Migrationen)
Domain/Politik src/domain/ Regel-Engine, Kostenregeln, Fallback-Logik
MCP-Server open-sse/mcp-server/ 37 Werkzeuge (30 Basis + 3 Speicher + 4 Fähigkeiten), 3 Transporte, ~13 Bereiche
A2A-Server src/lib/a2a/ JSON-RPC 2.0 Agent-Protokoll
Fähigkeiten src/lib/skills/ Erweiterbares Fähigkeitsframework
Speicher src/lib/memory/ Persistenter konversationeller Speicher

Monorepo: src/ (Next.js 16 App), open-sse/ (Streaming-Engine-Arbeitsbereich), electron/ (Desktop-App), tests/, bin/ (CLI-Einstiegspunkt).


Anfrage-Pipeline

Client → /v1/chat/completions (Next.js Route)
  → CORS → Zod-Validierung → Auth? → Richtlinienprüfung → Schutz vor Eingabeinjektion
  → handleChatCore() [open-sse/handlers/chatCore.ts]
    → Cache-Prüfung → Ratenbegrenzung → Kombinationsrouting?
      → resolveComboTargets() → handleSingleModel() pro Ziel
    → translateRequest() → getExecutor() → executor.execute()
      → fetch() upstream → erneut versuchen mit Backoff
    → Antwortübersetzung → SSE-Stream oder JSON
    → Wenn Responses API: responsesTransformer.ts TransformStream

API-Routen folgen einem konsistenten Muster: Route → CORS Preflight → Zod Body-Validierung → Optionale Authentifizierung (extractApiKey/isValidApiKey) → Durchsetzung der API-Schlüsselrichtlinie → Handler-Delegation (open-sse). Kein globales Next.js-Middleware — die Abfangung ist routenspezifisch.

Kombinationsrouting (open-sse/services/combo.ts): 14 Strategien (Priorität, gewichtet, zuerst auffüllen, Round-Robin, P2C, zufällig, am wenigsten verwendet, kostenoptimiert, reset-bewusst, strikt-zufällig, auto, lkgp, kontextoptimiert, kontextweiterleitung). Jedes Ziel ruft handleSingleModel() auf, das handleChatCore() mit fehlerbehandelnden und Schaltkreisprüfungen pro Ziel umschließt. Siehe docs/routing/AUTO-COMBO.md für die 9-Faktor Auto-Combo-Bewertung und docs/architecture/RESILIENCE_GUIDE.md für die 3 Resilienzschichten.


Resilienz-Laufzeitstatus

OmniRoute hat drei verwandte, aber unterschiedliche Mechanismen für temporäre Fehler. Halten Sie ihren Bereich beim Debuggen des Routing-Verhaltens getrennt. Siehe das 3-Schichten-Resilienzdiagramm (Quelle: docs/diagrams/resilience-3layers.mmd) für eine Übersichtskarte.

Anbieter-Schaltkreisunterbrecher

Bereich: ganzer Anbieter, z.B. glm, openai, anthropic.

Zweck: Stoppen des Datenverkehrs zu einem Anbieter, der wiederholt auf der Upstream-/Service-Ebene ausfällt, damit ein ungesunder Anbieter nicht jede Anfrage verlangsamt.

Implementierung:

  • Kernklasse: src/shared/utils/circuitBreaker.ts
  • Chat-Gate/Ausführungsverkabelung: src/sse/handlers/chatHelpers.ts, src/sse/handlers/chat.ts
  • Laufzeitstatus-API: src/app/api/monitoring/health/route.ts
  • Gemeinsame Wrapper: open-sse/services/accountFallback.ts
  • Persistierte Status-Tabelle: domain_circuit_breakers

Zustände:

  • CLOSED: normaler Datenverkehr ist erlaubt.
  • OPEN: Anbieter ist vorübergehend blockiert; Anrufer erhalten eine Antwort mit Anbieter-Schaltkreis-offen oder das Kombinationsrouting überspringt zu einem anderen Ziel.
  • HALF_OPEN: Reset-Timeout ist abgelaufen; eine Probeanforderung ist erlaubt. Erfolg schließt den Schalter, Misserfolg öffnet ihn erneut.

Standardeinstellungen (open-sse/config/constants.ts):

  • OAuth-Anbieter: Schwellenwert 3, Reset-Timeout 60s.
  • API-Schlüssel-Anbieter: Schwellenwert 5, Reset-Timeout 30s.
  • Lokale Anbieter: Schwellenwert 2, Reset-Timeout 15s.

Nur Anbieter-spezifische Fehlerstatus sollten den Anbieter-Schalter auslösen:

(408, 500, 502, 503, 504);

Lösen Sie den gesamten Anbieter-Schalter nicht für normale Konto-/Schlüssel-/Modellfehler wie die meisten 401, 403 oder 429 Fälle aus. Diese gehören normalerweise zu Verbindungsabkühlung oder Modell Sperrung. Ein generischer API-Schlüssel-Anbieter 403 sollte wiederherstellbar sein, es sei denn, er wird als terminaler Anbieter/Konto-Fehler klassifiziert.

Der Schalter verwendet eine verzögerte Wiederherstellung, keinen Hintergrundtimer. Wenn OPEN abläuft, werden Lesevorgänge wie getStatus(), canExecute() und getRetryAfterMs() den Status auf HALF_OPEN aktualisieren, sodass Dashboards und Kombinationskandidatenbauer einen abgelaufenen Anbieter nicht für immer ausschließen.

Verbindungsabkühlung

Bereich: eine Anbieter-Verbindung/Konto/Schlüssel.

Zweck: vorübergehend einen schlechten Schlüssel/Konto überspringen, während andere Verbindungen für den gleichen Anbieter weiterhin Anfragen bedienen.

Implementierung:

  • Schreib-/Aktualisierungspfad: src/sse/services/auth.ts::markAccountUnavailable()
  • Kontenauswahl/-filterung: src/sse/services/auth.ts::getProviderCredentials...
  • Abkühlungsberechnung: open-sse/services/accountFallback.ts::checkFallbackError()
  • Einstellungen: src/lib/resilience/settings.ts

Wichtige Felder bei Anbieter-Verbindungen:

rateLimitedUntil;
testStatus: "unavailable";
lastError;
lastErrorType;
errorCode;
backoffLevel;

Während der Kontenauswahl wird eine Verbindung übersprungen, während:

new Date(rateLimitedUntil).getTime() > Date.now();

Abkühlungen sind ebenfalls verzögert: Wenn rateLimitedUntil in der Vergangenheit liegt, wird die Verbindung wieder berechtigt. Bei erfolgreicher Nutzung löscht clearAccountError() testStatus, rateLimitedUntil, Fehlerfelder und backoffLevel.

Standardverhalten der Verbindungsabkühlung:

  • OAuth-Basisabkühlung: 5s.
  • API-Schlüssel-Basisabkühlung: 3s.
  • API-Schlüssel 429 sollte bevorzugt Hinweise für erneute Versuche von upstream verwenden (Retry-After, Reset-Header oder parsebaren Reset-Text), wenn verfügbar.
  • Wiederholte wiederherstellbare Fehler verwenden exponentielles Backoff:
baseCooldownMs * 2 ** failureIndex;

Der Anti-Thundering-Herd-Schutz verhindert, dass gleichzeitige Fehler bei derselben Verbindung die Abkühlung wiederholt verlängern oder backoffLevel doppelt erhöhen.

Terminalzustände sind keine Abkühlungen. banned, expired und credits_exhausted sollen unverfügbar bleiben, bis sich Anmeldeinformationen/Einstellungen ändern oder ein Betreiber sie zurücksetzt. Überschreiben Sie keine terminalen Zustände mit transienten Abkühlungszuständen.

Modell-Sperrung

Bereich: Anbieter + Verbindung + Modell.

Zweck: Vermeiden, dass eine ganze Verbindung deaktiviert wird, wenn nur ein Modell für diese Verbindung nicht verfügbar oder kontingentbeschränkt ist.

Beispiele:

  • Pro-Modell-Kontingent-Anbieter, die 429 zurückgeben.
  • Lokale Anbieter, die 404 für ein fehlendes Modell zurückgeben.
  • Anbieter-spezifische Modus-/Modellberechtigungsfehler wie ausgewählte Grok-Modi.

Die Modell-Sperrung befindet sich in open-sse/services/accountFallback.ts und ermöglicht es der gleichen Verbindung, weiterhin andere Modelle zu bedienen.

Debugging-Anleitung

  • Wenn alle Schlüssel für einen Anbieter übersprungen werden, überprüfen Sie sowohl den Status des Anbieterschalters als auch rateLimitedUntil/testStatus jeder Verbindung.
  • Wenn ein Anbieter nach dem Reset-Fenster dauerhaft ausgeschlossen erscheint, überprüfen Sie, ob der Code den Rohstatus state anstelle von getStatus()/canExecute() liest.
  • Wenn ein Anbieter-Schlüssel fehlschlägt, aber andere funktionieren sollten, bevorzugen Sie die Verbindungsabkühlung gegenüber dem Anbieter-Schalter.
  • Wenn nur ein Modell fehlschlägt, bevorzugen Sie die Modell-Sperrung gegenüber der Verbindungsabkühlung.
  • Wenn ein Zustand sich selbst wiederherstellen sollte, sollte er einen zukünftigen Zeitstempel/Reset-Timeout und einen Leseweg haben, der abgelaufene Zustände aktualisiert. Permanente Status erfordern manuelle Änderungen an Anmeldeinformationen oder Konfiguration.

Schlüsselkonventionen

Code-Stil

  • 2 Leerzeichen, Semikolons, doppelte Anführungszeichen, 100 Zeichen Breite, es5 nachgestellte Kommas (durch lint-staged über Prettier durchgesetzt)
  • Imports: extern → intern (@/, @omniroute/open-sse) → relativ
  • Benennung: Dateien=camelCase/kebab, Komponenten=PascalCase, Konstanten=UPPER_SNAKE
  • ESLint: no-eval, no-implied-eval, no-new-func = Fehler überall; no-explicit-any = Warnung in open-sse/ und tests/
  • TypeScript: strict: false, Ziel ES2022, Modul esnext, Auflösung Bundler. Bevorzugen Sie explizite Typen.

Datenbank

  • Immer über src/lib/db/ Domänenmodule gehen — nie rohes SQL in Routen oder Handlern schreiben
  • Nie Logik zu src/lib/localDb.ts hinzufügen (nur Re-Export-Schicht)
  • Nie Barrel-Import von localDb.ts — stattdessen spezifische db/-Module importieren
  • DB-Singleton: getDbInstance() aus src/lib/db/core.ts (WAL-Journaling)
  • Migrationen: src/lib/db/migrations/ — versionierte SQL-Dateien, idempotent, in Transaktionen ausführen

Fehlerbehandlung

  • try/catch mit spezifischen Fehlertypen, protokollieren mit pino-Kontext
  • Nie Fehler in SSE-Streams unterdrücken — verwenden Sie Abbruchsignale zur Bereinigung
  • Geben Sie die richtigen HTTP-Statuscodes zurück (4xx/5xx)

Sicherheit

  • Nie eval(), new Function(), oder implizites eval verwenden
  • Validieren Sie alle Eingaben mit Zod-Schemas
  • Verschlüsseln Sie Anmeldeinformationen im Ruhezustand (AES-256-GCM)
  • Upstream-Header-Denylist: src/shared/constants/upstreamHeaders.ts — halten Sie Sanitär-, Zod-Schemas und Unit-Tests beim Bearbeiten synchron
  • Öffentliche Upstream-Anmeldeinformationen (Gemini/Antigravity/Windsurf-Stil OAuth client_id/secret + Firebase Web-Schlüssel, die aus öffentlichen CLIs extrahiert wurden): MÜSSEN über resolvePublicCred() aus open-sse/utils/publicCreds.ts eingebettet werden — nie als String-Literale. Siehe docs/security/PUBLIC_CREDS.md für das obligatorische Muster.
  • Fehlerantworten (HTTP / SSE / Executor / MCP-Handler): MÜSSEN über buildErrorBody() oder sanitizeErrorMessage() aus open-sse/utils/error.ts geleitet werden — nie rohes err.stack oder err.message in einem Antwortkörper einfügen. Siehe docs/security/ERROR_SANITIZATION.md.
  • Shell-Befehle, die aus Variablen erstellt werden: beim Aufrufen von exec()/spawn() mit einem Skript, das Laufzeitwerte benötigt, übergeben Sie diese über die env-Option (automatisch shell-escaped) — nie untrusted/externe Pfade in den Skriptkörper interpolieren. Referenz: src/mitm/cert/install.ts::updateNssDatabases.
  • Sichere Standardbibliotheken (tldrsec/awesome-secure-defaults): Bevorzugen Sie Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink gegenüber benutzerdefinierten Implementierungen, wenn Sie neue sicherheitskritische Oberflächen hinzufügen.

Häufige Änderungszenarien

Hinzufügen eines neuen Anbieters

  1. Registrieren Sie sich in src/shared/constants/providers.ts (Zod-validiert beim Laden)
  2. Fügen Sie einen Executor in open-sse/executors/ hinzu, wenn benutzerdefinierte Logik benötigt wird (erweitern Sie BaseExecutor)
  3. Fügen Sie einen Übersetzer in open-sse/translator/ hinzu, wenn es sich um ein nicht-OpenAI-Format handelt
  4. Fügen Sie die OAuth-Konfiguration in src/lib/oauth/constants/oauth.ts hinzu, wenn OAuth-basiert — wenn die Upstream-CLI eine öffentliche client_id/secret bereitstellt, betten Sie sie über resolvePublicCred() ein (siehe docs/security/PUBLIC_CREDS.md), nie als Literal
  5. Registrieren Sie Modelle in open-sse/config/providerRegistry.ts
  6. Schreiben Sie Tests in tests/unit/ (einschließlich der öffentlichen Creds-Formassertion, wenn Sie ein neues eingebettetes Standard hinzugefügt haben)

Hinzufügen einer neuen API-Route

  1. Erstellen Sie ein Verzeichnis unter src/app/api/v1/your-route/
  2. Erstellen Sie route.ts mit GET/POST-Handlern
  3. Folgen Sie dem Muster: CORS → Zod-Body-Validierung → optionale Authentifizierung → Handler-Delegation
  4. Der Handler geht in open-sse/handlers/ (von dort importieren, nicht inline)
  5. Fehlerantworten verwenden buildErrorBody() / errorResponse() aus open-sse/utils/error.ts (automatisch sanitisiert — niemals err.stack oder err.message roh im Körper einfügen). Siehe docs/security/ERROR_SANITIZATION.md.
  6. Fügen Sie Tests hinzu — einschließlich mindestens einer Assertion, dass Fehlerantworten keine Stack-Traces ausgeben (!body.error.message.includes("at /"))

Hinzufügen eines neuen DB-Moduls

  1. Erstellen Sie src/lib/db/yourModule.ts — importieren Sie getDbInstance aus ./core.ts
  2. Exportieren Sie CRUD-Funktionen für Ihre Domänentabelle(n)
  3. Fügen Sie eine Migration in src/lib/db/migrations/ hinzu, wenn neue Tabellen benötigt werden
  4. Re-Exportieren Sie aus src/lib/localDb.ts (nur zur Re-Exportliste hinzufügen)
  5. Schreiben Sie Tests

Hinzufügen eines neuen MCP-Tools

  1. Fügen Sie die Tool-Definition in open-sse/mcp-server/tools/ mit Zod-Eingabeschema + asynchronem Handler hinzu
  2. Registrieren Sie sich im Tool-Set (verkabelt durch createMcpServer())
  3. Weisen Sie die entsprechenden Bereiche zu
  4. Schreiben Sie Tests (Toolaufruf wird in der mcp_audit-Tabelle protokolliert)

Hinzufügen einer neuen A2A-Fähigkeit

  1. Erstellen Sie die Fähigkeit in src/lib/a2a/skills/ (5 existieren bereits: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
  2. Die Fähigkeit erhält den Aufgaben-Kontext (Nachrichten, Metadaten) → gibt ein strukturiertes Ergebnis zurück
  3. Registrieren Sie sich in A2A_SKILL_HANDLERS in src/lib/a2a/taskExecution.ts
  4. Exponieren Sie in src/app/.well-known/agent.json/route.ts (Agent Card)
  5. Schreiben Sie Tests in tests/unit/
  6. Dokumentieren Sie in docs/frameworks/A2A-SERVER.md in der Fähigkeits-Tabelle

Hinzufügen eines neuen Cloud-Agenten

  1. Erstellen Sie die Agentenklasse in src/lib/cloudAgent/agents/, die CloudAgentBase erweitert (3 existieren bereits: codex-cloud, devin, jules)
  2. Implementieren Sie createTask, getStatus, approvePlan, sendMessage, listSources
  3. Registrieren Sie sich in src/lib/cloudAgent/registry.ts
  4. Fügen Sie die OAuth-/Anmeldeinformationsbehandlung hinzu, falls erforderlich (src/lib/oauth/providers/)
  5. Tests + Dokumentation in docs/frameworks/CLOUD_AGENT.md

Hinzufügen eines neuen Guardrails / Eval / Skill / Webhook-Ereignis

  • Guardrail: src/lib/guardrails/ → Dokumente: docs/security/GUARDRAILS.md
  • Eval-Suite: src/lib/evals/ → Dokumente: docs/frameworks/EVALS.md
  • Skill (Sandbox): src/lib/skills/ → Dokumente: docs/frameworks/SKILLS.md
  • Webhook-Ereignis: src/lib/webhookDispatcher.ts → Dokumente: docs/frameworks/WEBHOOKS.md

Referenzdokumentation

Für jede nicht triviale Änderung lesen Sie zuerst das entsprechende Deep-Dive:

Bereich Dokument
Repo-Navigation docs/architecture/REPOSITORY_MAP.md
Architektur docs/architecture/ARCHITECTURE.md
Ingenieureferenzen docs/architecture/CODEBASE_DOCUMENTATION.md
Auto-Combo (9-Faktoren-Bewertung, 14 Strategien) docs/routing/AUTO-COMBO.md
Resilienz (3 Mechanismen) docs/architecture/RESILIENCE_GUIDE.md
Reasoning Replay docs/routing/REASONING_REPLAY.md
Fähigkeiten-Rahmen docs/frameworks/SKILLS.md
Gedächtnissystem (FTS5 + Qdrant) docs/frameworks/MEMORY.md
Cloud-Agenten docs/frameworks/CLOUD_AGENT.md
Leitplanken (PII / Injektion / Vision) docs/security/GUARDRAILS.md
Öffentliche Upstream-Anmeldeinformationen (Gemini/etc.) docs/security/PUBLIC_CREDS.md
Fehlernachrichtensanitierung docs/security/ERROR_SANITIZATION.md
Bewertungen docs/frameworks/EVALS.md
Compliance / Audit docs/security/COMPLIANCE.md
Webhooks docs/frameworks/WEBHOOKS.md
Autorisierungs-Pipeline docs/architecture/AUTHZ_GUIDE.md
Stealth (TLS / Fingerabdruck) docs/security/STEALTH_GUIDE.md
Agent-Protokolle (A2A / ACP / Cloud) docs/frameworks/AGENT_PROTOCOLS_GUIDE.md
MCP-Server docs/frameworks/MCP-SERVER.md
A2A-Server docs/frameworks/A2A-SERVER.md
API-Referenz + OpenAPI docs/reference/API_REFERENCE.md + docs/reference/openapi.yaml
Anbieterkatalog (automatisch generiert) docs/reference/PROVIDER_REFERENCE.md
Release-Flow docs/ops/RELEASE_CHECKLIST.md

Testen

Was Befehl
Unit-Tests npm run test:unit
Einzelne Datei node --import tsx/esm --test tests/unit/file.test.ts
Vitest (MCP, autoCombo) npm run test:vitest
E2E (Playwright) npm run test:e2e
Protokoll E2E (MCP+A2A) npm run test:protocols:e2e
Ökosystem npm run test:ecosystem
Coverage-Gate npm run test:coverage (75/75/75/70 — Anweisungen/Zeilen/Funktionen/Zweige)
Coverage-Bericht npm run coverage:report

PR-Regel: Wenn Sie Produktionscode in src/, open-sse/, electron/ oder bin/ ändern, müssen Sie Tests im selben PR einfügen oder aktualisieren.

Testschicht-Präferenz: Unit zuerst → Integration (Multi-Modul oder DB-Zustand) → E2E (UI/Workflow nur). Kodieren Sie Fehlerreproduktionen als automatisierte Tests vor oder zusammen mit der Behebung.

Copilot-Coverage-Richtlinie: Wenn ein PR Produktionscode ändert und die Abdeckung unter 75% (Anweisungen/Zeilen/Funktionen) oder 70% (Zweige) liegt, berichten Sie nicht nur — fügen Sie Tests hinzu oder aktualisieren Sie diese, führen Sie das Coverage-Gate erneut aus und bitten Sie um Bestätigung. Fügen Sie die ausgeführten Befehle, geänderten Testdateien und das endgültige Abdeckungsergebnis im PR-Bericht hinzu.


Git-Workflow

# Niemals direkt in main committen
git checkout -b feat/your-feature
git commit -m "feat: beschreibe deine Änderung"
git push -u origin feat/your-feature

Branch-Präfixe: feat/, fix/, refactor/, docs/, test/, chore/

Commit-Format (Conventional Commits): feat(db): circuit breaker hinzufügen — Scopes: db, sse, oauth, dashboard, api, cli, docker, ci, mcp, a2a, memory, skills

Husky-Hooks:

  • pre-commit: lint-staged + check-docs-sync + check:any-budget:t11
  • pre-push: npm run test:unit

Umgebung

  • Laufzeit: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES-Module
  • TypeScript: 5.9+, Ziel ES2022, Modul esnext, Auflösung Bundler
  • Pfad-Aliase: @/*src/, @omniroute/open-sseopen-sse/, @omniroute/open-sse/*open-sse/*
  • Standardport: 20128 (API + Dashboard am selben Port)
  • Datenverzeichnis: DATA_DIR Umgebungsvariable, standardmäßig ~/.omniroute/
  • Wichtige Umgebungsvariablen: PORT, JWT_SECRET, API_KEY_SECRET, INITIAL_PASSWORD, REQUIRE_API_KEY, APP_LOG_LEVEL
  • Einrichtung: cp .env.example .env und dann JWT_SECRET (openssl rand -base64 48) und API_KEY_SECRET (openssl rand -hex 32) generieren

Harte Regeln

  1. Niemals Geheimnisse oder Anmeldeinformationen committen
  2. Niemals Logik in localDb.ts hinzufügen
  3. Niemals eval() / new Function() / implizites eval verwenden
  4. Niemals direkt in main committen
  5. Niemals rohes SQL in Routen schreiben — verwenden Sie src/lib/db/-Module
  6. Niemals Fehler in SSE-Streams stillschweigend unterdrücken
  7. Immer Eingaben mit Zod-Schemas validieren
  8. Immer Tests einfügen, wenn Produktionscode geändert wird
  9. Die Abdeckung muss ≥75% (Anweisungen, Zeilen, Funktionen) / ≥70% (Zweige) bleiben. Aktuell gemessen: ~82%.
  10. Niemals Husky-Hooks umgehen (--no-verify, --no-gpg-sign) ohne ausdrückliche Genehmigung des Betreibers.
  11. Niemals öffentliche Upstream OAuth client_id/secret oder Firebase Web-Schlüssel als String-Literale einbetten — immer über resolvePublicCred() (open-sse/utils/publicCreds.ts) gehen. Siehe docs/security/PUBLIC_CREDS.md.
  12. Niemals rohes err.stack / err.message in HTTP / SSE / Executor-Antworten zurückgeben — immer über buildErrorBody() oder sanitizeErrorMessage() (open-sse/utils/error.ts) leiten. Siehe docs/security/ERROR_SANITIZATION.md.
  13. Niemals externe Pfade oder Laufzeitwerte in Shell-Skripte interpolieren, die an exec()/spawn() übergeben werden — stattdessen über die env-Option übergeben. Referenz: src/mitm/cert/install.ts::updateNssDatabases.
  14. Niemals einen CodeQL / Secret-Scanning-Alarm ohne (a) vorherige Überprüfung der Musterdokumentation oben, um zu sehen, ob der Helfer anwendbar ist, und (b) die technische Begründung im Ablehnungs-Kommentar aufzeichnen. Präzedenzfall: js/stack-trace-exposure, das an Callsites ausgelöst wird, die bereits über sanitizeErrorMessage() geleitet werden, ist eine bekannte CodeQL-Einschränkung (benutzerdefinierte Sanitizer werden nicht erkannt) — als false positive abweisen mit Verweis auf docs/security/ERROR_SANITIZATION.md.
  15. Niemals Routen, die Kindprozesse erzeugen (/api/mcp/, /api/cli-tools/runtime/), ohne isLocalOnlyPath()-Klassifizierung in src/server/authz/routeGuard.ts einbeziehen. Die Loopback-Durchsetzung erfolgt bedingungslos vor jeder Authentifizierungsprüfung — ein durch Tunnel geleakter JWT kann keinen Prozessstart auslösen. Siehe docs/security/ROUTE_GUARD_TIERS.md.
  16. Niemals Co-Authored-By-Trailer einfügen, die einen KI-Assistenten, LLM oder Automatisierungskonto würdigen (z. B. Namen mit "Claude", "GPT", "Copilot", "Bot"; E-Mails unter anthropic.com / openai.com / bot-eigenen noreply.github.com-Adressen). Solche Trailer leiten die Commit-Zuordnung auf das Bot-Konto auf GitHub um und verbergen den echten Autor (diegosouzapw) in der PR-Historie. Menschliche Mitwirkende — einschließlich Upstream-PR-Autoren und Issue-Berichterstattern, die in OmniRoute portiert werden — DÜRFEN und SOLLTEN mit standardmäßigen Co-authored-by: Name <email>-Trailern gewürdigt werden; die Upstream-Port-Workflows (/port-upstream-features, /port-upstream-issues) hängen davon ab.