Files
OmniRoute/docs/i18n/mr/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

391 lines
44 KiB
Markdown

# CLAUDE.md (मराठी)
🌐 **Languages:** 🇺🇸 [English](../../../CLAUDE.md) · 🇸🇦 [ar](../ar/CLAUDE.md) · 🇦🇿 [az](../az/CLAUDE.md) · 🇧🇬 [bg](../bg/CLAUDE.md) · 🇧🇩 [bn](../bn/CLAUDE.md) · 🇨🇿 [cs](../cs/CLAUDE.md) · 🇩🇰 [da](../da/CLAUDE.md) · 🇩🇪 [de](../de/CLAUDE.md) · 🇪🇸 [es](../es/CLAUDE.md) · 🇮🇷 [fa](../fa/CLAUDE.md) · 🇫🇮 [fi](../fi/CLAUDE.md) · 🇫🇷 [fr](../fr/CLAUDE.md) · 🇮🇳 [gu](../gu/CLAUDE.md) · 🇮🇱 [he](../he/CLAUDE.md) · 🇮🇳 [hi](../hi/CLAUDE.md) · 🇭🇺 [hu](../hu/CLAUDE.md) · 🇮🇩 [id](../id/CLAUDE.md) · 🇮🇩 [in](../in/CLAUDE.md) · 🇮🇹 [it](../it/CLAUDE.md) · 🇯🇵 [ja](../ja/CLAUDE.md) · 🇰🇷 [ko](../ko/CLAUDE.md) · 🇲🇾 [ms](../ms/CLAUDE.md) · 🇳🇱 [nl](../nl/CLAUDE.md) · 🇳🇴 [no](../no/CLAUDE.md) · 🇵🇭 [phi](../phi/CLAUDE.md) · 🇵🇱 [pl](../pl/CLAUDE.md) · 🇵🇹 [pt](../pt/CLAUDE.md) · 🇧🇷 [pt-BR](../pt-BR/CLAUDE.md) · 🇷🇴 [ro](../ro/CLAUDE.md) · 🇷🇺 [ru](../ru/CLAUDE.md) · 🇸🇰 [sk](../sk/CLAUDE.md) · 🇸🇪 [sv](../sv/CLAUDE.md) · 🇰🇪 [sw](../sw/CLAUDE.md) · 🇮🇳 [ta](../ta/CLAUDE.md) · 🇮🇳 [te](../te/CLAUDE.md) · 🇹🇭 [th](../th/CLAUDE.md) · 🇹🇷 [tr](../tr/CLAUDE.md) · 🇺🇦 [uk-UA](../uk-UA/CLAUDE.md) · 🇵🇰 [ur](../ur/CLAUDE.md) · 🇻🇳 [vi](../vi/CLAUDE.md) · 🇨🇳 [zh-CN](../zh-CN/CLAUDE.md)
---
या फाइलमध्ये या रेपॉजिटरीमध्ये कोडवर काम करताना Claude Code (claude.ai/code) साठी मार्गदर्शन दिले आहे.
## जलद प्रारंभ
```bash
npm install # निर्भरता स्थापित करा (.auto-generates .env from .env.example)
npm run dev # विकास सर्व्हर http://localhost:20128 वर
npm run build # उत्पादन बिल्ड (Next.js 16 स्वतंत्र)
npm run lint # ESLint (0 त्रुटी अपेक्षित; चेतावण्या पूर्वीच आहेत)
npm run typecheck:core # TypeScript तपासणी (स्वच्छ असावी)
npm run typecheck:noimplicit:core # कठोर तपासणी (कोणतीही अप्रत्यक्ष नाही)
npm run test:coverage # युनिट चाचण्या + कव्हरेज गेट (75/75/75/70 — विधान/रेषा/कार्ये/शाखा)
npm run check # lint + चाचणी एकत्रित
npm run check:cycles # वर्तुळाकार अवलंबन शोधा
```
### चाचण्या चालवणे
```bash
# एकल चाचणी फाइल (Node.js स्थानिक चाचणी धावक — बहुतेक चाचण्या)
node --import tsx/esm --test tests/unit/your-file.test.ts
# Vitest (MCP सर्व्हर, autoCombo, कॅश)
npm run test:vitest
# सर्व सूट
npm run test:all
```
पूर्ण चाचणी मॅट्रिक्ससाठी, `CONTRIBUTING.md` पहा → "चाचण्या चालवणे". गहन आर्किटेक्चरसाठी, `AGENTS.md` पहा.
---
## प्रकल्पाचा आढावा
**OmniRoute** — एकत्रित AI प्रॉक्सी/राउटर. एक एंडपॉइंट, 160+ LLM प्रदाते, स्वयंचलित फॉलबॅक.
| स्तर | स्थान | उद्देश |
| ------------- | ----------------------- | ------------------------------------------------------------ |
| API मार्ग | `src/app/api/v1/` | Next.js अॅप राउटर — प्रवेश बिंदू |
| हँडलर्स | `open-sse/handlers/` | विनंती प्रक्रिया (चॅट, एम्बेडिंग, इ.) |
| कार्यान्वयक | `open-sse/executors/` | प्रदाता-विशिष्ट HTTP वितरण |
| भाषांतरक | `open-sse/translator/` | स्वरूप रूपांतरण (OpenAI↔Claude↔Gemini) |
| ट्रान्सफार्मर | `open-sse/transformer/` | प्रतिसाद API ↔ चॅट पूर्णता |
| सेवा | `open-sse/services/` | कॉम्बो राउटिंग, दर मर्यादा, कॅशिंग, इ. |
| डेटाबेस | `src/lib/db/` | SQLite डोमेन मॉड्यूल (45+ फाइल, 55 स्थलांतर) |
| डोमेन/नीती | `src/domain/` | नीती इंजिन, खर्च नियम, फॉलबॅक लॉजिक |
| MCP सर्व्हर | `open-sse/mcp-server/` | 37 साधने (30 बेस + 3 मेमरी + 4 कौशल्य), 3 वाहने, ~13 स्कोप्स |
| A2A सर्व्हर | `src/lib/a2a/` | JSON-RPC 2.0 एजंट प्रोटोकॉल |
| कौशल्य | `src/lib/skills/` | विस्तारणीय कौशल्य फ्रेमवर्क |
| मेमरी | `src/lib/memory/` | कायमचे संवादात्मक मेमरी |
मोनोरेपो: `src/` (Next.js 16 अॅप), `open-sse/` (स्ट्रीमिंग इंजिन कार्यक्षेत्र), `electron/` (डेस्कटॉप अॅप), `tests/`, `bin/` (CLI प्रवेश बिंदू).
---
## विनंती पाईपलाइन
```
Client → /v1/chat/completions (Next.js मार्ग)
→ CORS → Zod प्रमाणीकरण → auth? → धोरण तपासणी → प्रॉम्प्ट इंजेक्शन गार्ड
→ handleChatCore() [open-sse/handlers/chatCore.ts]
→ कॅश तपासणी → दर मर्यादा → कॉम्बो रूटिंग?
→ resolveComboTargets() → handleSingleModel() प्रति लक्ष्य
→ translateRequest() → getExecutor() → executor.execute()
→ fetch() अपस्ट्रीम → retry w/ backoff
→ प्रतिसाद भाषांतर → SSE प्रवाह किंवा JSON
→ जर प्रतिसाद API: responsesTransformer.ts TransformStream
```
API मार्ग एक सुसंगत नमुना अनुसरण करतात: `Route → CORS प्रीफ्लाइट → Zod शरीर प्रमाणीकरण → वैकल्पिक auth (extractApiKey/isValidApiKey) → API की धोरण अंमलबजावणी → हँडलर प्रतिनिधित्व (open-sse)`. कोणताही जागतिक Next.js मिडलवेअर नाही — हस्तक्षेप मार्ग-विशिष्ट आहे.
**कॉम्बो रूटिंग** (`open-sse/services/combo.ts`): 14 रणनीती (प्राधान्य, वजनदार, भर-प्रथम, राउंड-रॉबिन, P2C, यादृच्छिक, कमी-उपयोग, खर्च-ऑप्टिमाइझ, रीसेट-ज्ञानी, कठोर-यादृच्छिक, स्वयंचलित, lkgp, संदर्भ-ऑप्टिमाइझ, संदर्भ-रिले). प्रत्येक लक्ष्य `handleSingleModel()` कॉल करते जे `handleChatCore()` ला प्रति-लक्ष्य त्रुटी हाताळणी आणि सर्किट ब्रेकर तपासणीसह लपवते. 9-फॅक्टर ऑटो-कॉम्बो स्कोअरिंगसाठी `docs/routing/AUTO-COMBO.md` पहा आणि 3 प्रतिकार स्तरांसाठी `docs/architecture/RESILIENCE_GUIDE.md` पहा.
---
## प्रतिकार रनटाइम स्थिती
OmniRoute कडे तीन संबंधित पण भिन्न तात्पुरत्या-अपयश यांत्रिके आहेत. रूटिंग वर्तन डिबग करताना त्यांचा व्याप्ती वेगळी ठेवा. एक झलक नकाशासाठी [3-लेयर प्रतिकार आरेख](./docs/diagrams/exported/resilience-3layers.svg) पहा (स्त्रोत: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd)).
### प्रदाता सर्किट ब्रेकर
**व्याप्ती**: संपूर्ण प्रदाता, उदा. `glm`, `openai`, `anthropic`.
**उद्दिष्ट**: अपस्ट्रीम/सेवा स्तरावर वारंवार अपयशी ठरलेल्या प्रदात्याकडे ट्रॅफिक पाठवणे थांबवणे, त्यामुळे एक अस्वस्थ प्रदाता प्रत्येक विनंतीला मंदावणार नाही.
**अंमलबजावणी**:
- मुख्य वर्ग: `src/shared/utils/circuitBreaker.ts`
- चॅट गेट/कार्यवाही वायरिंग: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
- रनटाइम स्थिती API: `src/app/api/monitoring/health/route.ts`
- सामायिक रॅपर: `open-sse/services/accountFallback.ts`
- कायमस्वरूपी स्थिती टेबल: `domain_circuit_breakers`
**स्थिती**:
- `CLOSED`: सामान्य ट्रॅफिकची परवानगी आहे.
- `OPEN`: प्रदाता तात्पुरता ब्लॉक केलेला आहे; कॉलर्सना प्रदाता-सर्किट-ओपन प्रतिसाद मिळतो किंवा कॉम्बो रूटिंग दुसऱ्या लक्ष्याकडे वळते.
- `HALF_OPEN`: रीसेट टाइमआउट संपला आहे; एक प्रॉब विनंती परवानगी द्या. यशस्वी झाल्यास ब्रेकर बंद होतो, अपयशी झाल्यास पुन्हा उघडतो.
**डीफॉल्ट्स** (`open-sse/config/constants.ts`):
- OAuth प्रदाते: थ्रेशोल्ड `3`, रीसेट टाइमआउट `60s`.
- API-key प्रदाते: थ्रेशोल्ड `5`, रीसेट टाइमआउट `30s`.
- स्थानिक प्रदाते: थ्रेशोल्ड `2`, रीसेट टाइमआउट `15s`.
फक्त प्रदाता-स्तरीय अपयश स्थिती प्रदाता ब्रेकरला ट्रिप करायला हवी:
```ts
(408, 500, 502, 503, 504);
```
सामान्य खाते/की/मॉडेल त्रुटी जसे की बहुतेक `401`, `403`, किंवा `429` प्रकरणांसाठी संपूर्ण प्रदाता ब्रेकरला ट्रिप करू नका. त्या सामान्यतः कनेक्शन कूलडाऊन किंवा मॉडेल लॉकआउटमध्ये असतात. एक सामान्य API-key प्रदाता `403` पुनर्प्राप्त करण्यायोग्य असावा, जोपर्यंत तो एक टर्मिनल प्रदाता/खाते त्रुटी म्हणून वर्गीकृत केलेला नाही.
ब्रेकर आलसी पुनर्प्राप्ती वापरतो, पार्श्वभूमी टाइमर नाही. जेव्हा `OPEN` संपते, तेव्हा `getStatus()`, `canExecute()`, आणि `getRetryAfterMs()` सारख्या वाचनांनी स्थिती `HALF_OPEN` मध्ये ताजेतवाने करते, त्यामुळे डॅशबोर्ड आणि कॉम्बो उमेदवार बिल्डर्स एक कालबाह्य प्रदाता कायमचा वगळत नाहीत.
### कनेक्शन कूलडाऊन
**व्याप्ती**: एक प्रदाता कनेक्शन/खाते/की.
**उद्दिष्ट**: एक वाईट की/खाते तात्पुरते वगळताना त्याच प्रदाता साठी इतर कनेक्शनना विनंत्या सेवा देण्याची परवानगी देणे.
**अंमलबजावणी**:
- लेखा/अपडेट पथ: `src/sse/services/auth.ts::markAccountUnavailable()`
- खाते निवड/फिल्टरिंग: `src/sse/services/auth.ts::getProviderCredentials...`
- कूलडाऊन गणना: `open-sse/services/accountFallback.ts::checkFallbackError()`
- सेटिंग्ज: `src/lib/resilience/settings.ts`
प्रदाता कनेक्शनवरील महत्त्वाचे क्षेत्र:
```ts
rateLimitedUntil;
testStatus: "unavailable";
lastError;
lastErrorType;
errorCode;
backoffLevel;
```
खाते निवडताना, एक कनेक्शन वगळले जाते जेव्हा:
```ts
new Date(rateLimitedUntil).getTime() > Date.now();
```
कूलडाऊन देखील आलसी आहेत: जेव्हा `rateLimitedUntil` भूतकाळात असतो, तेव्हा कनेक्शन पुन्हा पात्र होते. यशस्वी वापरावर, `clearAccountError()` `testStatus`, `rateLimitedUntil`, त्रुटी क्षेत्र, आणि `backoffLevel` साफ करते.
डीफॉल्ट कनेक्शन कूलडाऊन वर्तन:
- OAuth बेस कूलडाऊन: `5s`.
- API-key बेस कूलडाऊन: `3s`.
- API-key `429` उपलब्ध असल्यास अपस्ट्रीम पुनर्प्रयत्न संकेत (`Retry-After`, रीसेट हेडर, किंवा पार्स करण्यायोग्य रीसेट मजकूर) प्राधान्य द्यावे.
- पुनरावृत्ती होणाऱ्या पुनर्प्राप्त होणाऱ्या अपयशांवर गुणाकार बॅकऑफ वापरला जातो:
```ts
baseCooldownMs * 2 ** failureIndex;
```
अँटी-थंडरिंग-हर्ड गार्ड एकाच कनेक्शनवरील समांतर अपयशांना कूलडाऊन वाढविण्यासाठी किंवा `backoffLevel` द्विगुणित करण्यापासून प्रतिबंधित करतो.
टर्मिनल स्थिती कूलडाऊन नाहीत. `banned`, `expired`, आणि `credits_exhausted` क्रेडेन्शियल्स/सेटिंग्ज बदलल्याशिवाय किंवा ऑपरेटरने त्यांना रीसेट केल्याशिवाय अनुपलब्ध राहण्याचा उद्देश आहे. तात्पुरत्या कूलडाऊन स्थितीसह टर्मिनल स्थिती ओव्हरराइट करू नका.
### मॉडेल लॉकआउट
**व्याप्ती**: प्रदाता + कनेक्शन + मॉडेल.
**उद्दिष्ट**: एकाच कनेक्शनसाठी फक्त एक मॉडेल अनुपलब्ध किंवा कोटा-सीमित असताना संपूर्ण कनेक्शन बंद करणे टाळणे.
उदाहरणे:
- प्रति-मॉडेल कोटा प्रदाते `429` परत करत आहेत.
- स्थानिक प्रदाते एक गहाळ मॉडेलसाठी `404` परत करत आहेत.
- प्रदाता-विशिष्ट मोड/मॉडेल परवानगी अपयश जसे की निवडलेले Grok मोड.
मॉडेल लॉकआउट `open-sse/services/accountFallback.ts` मध्ये राहते आणि त्याच कनेक्शनला इतर मॉडेल्स सेवा देण्याची परवानगी देते.
### डिबगिंग मार्गदर्शन
- जर प्रदाता साठी सर्व की वगळल्या गेल्या असतील, तर प्रदाता ब्रेकर स्थिती आणि प्रत्येक कनेक्शनच्या `rateLimitedUntil`/`testStatus` तपासा.
- जर रीसेट विंडो नंतर प्रदाता कायमचा वगळलेला दिसत असेल, तर तपासा की कोड कच्चा `state` वाचत आहे की `getStatus()`/`canExecute()` वापरत आहे.
- जर एक प्रदाता की अपयशी झाली पण इतर कार्य करायला हवे, तर प्रदाता ब्रेकरवर कनेक्शन कूलडाऊन प्राधान्य द्या.
- जर फक्त एक मॉडेल अपयशी झाली, तर कनेक्शन कूलडाऊनवर मॉडेल लॉकआउट प्राधान्य द्या.
- जर एक स्थिती स्वतः पुनर्प्राप्त होणे आवश्यक असेल, तर त्यात भविष्यकालीन टाइमस्टॅम्प/रीसेट टाइमआउट आणि एक वाचन पथ असावा जो कालबाह्य स्थिती ताजेतवाने करतो. कायमच्या स्थितींसाठी मॅन्युअल क्रेडेन्शियल किंवा कॉन्फिग बदल आवश्यक आहेत.
## मुख्य संकल्पना
### कोड शैली
- **2 जागा**, सेमीकोलन, डबल कोट्स, 100 वर्ण रुंदी, es5 ट्रेलिंग कॉमा (lint-staged द्वारे Prettier द्वारे लागू केले)
- **आयात**: बाह्य → अंतर्गत (`@/`, `@omniroute/open-sse`) → सापेक्ष
- **नावकरण**: फाइल्स=camelCase/kebab, घटक=PascalCase, स्थिरांक=UPPER_SNAKE
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = सर्वत्र त्रुटी; `no-explicit-any` = `open-sse/` आणि `tests/` मध्ये चेतावणी
- **TypeScript**: `strict: false`, लक्ष्य ES2022, मॉड्यूल esnext, रिझोल्यूशन बंडलर. स्पष्ट प्रकारांना प्राधान्य द्या.
### डेटाबेस
- **सर्व वेळ** `src/lib/db/` डोमेन मॉड्यूलद्वारे जा — **कधीही** मार्ग किंवा हँडलरमध्ये कच्चा SQL लिहू नका
- **कधीही** `src/lib/localDb.ts` मध्ये लॉजिक जोडू नका (फक्त पुनः-निर्यात स्तर)
- **कधीही** `localDb.ts` कडून बॅरल-आयात करू नका — त्याऐवजी विशिष्ट `db/` मॉड्यूल आयात करा
- DB सिंगलटन: `getDbInstance()` `src/lib/db/core.ts` कडून (WAL जर्नलिंग)
- स्थलांतर: `src/lib/db/migrations/` — आवृत्त SQL फाइल्स, आयडेम्पोटेंट, व्यवहारांमध्ये चालवा
### त्रुटी हाताळणी
- विशिष्ट त्रुटी प्रकारांसह try/catch, पिनो संदर्भासह लॉग करा
- SSE प्रवाहांमध्ये त्रुटी गिळू नका — स्वच्छतेसाठी abort सिग्नल वापरा
- योग्य HTTP स्थिती कोड परत करा (4xx/5xx)
### सुरक्षा
- **कधीही** `eval()`, `new Function()`, किंवा implied eval वापरू नका
- सर्व इनपुट Zod स्कीमासह प्रमाणित करा
- विश्रांतीत क्रेडेन्शियल्स एन्क्रिप्ट करा (AES-256-GCM)
- अपस्ट्रीम हेडर डिनायलिस्ट: `src/shared/constants/upstreamHeaders.ts` — संपादित करताना स्वच्छता, Zod स्कीमा, आणि युनिट चाचण्या समांतर ठेवा
- **सार्वजनिक अपस्ट्रीम क्रेडेन्शियल्स** (Gemini/Antigravity/Windsurf-शैली OAuth client_id/secret + Firebase वेब कीज सार्वजनिक CLIs कडून काढलेल्या): **आवश्यक** `resolvePublicCred()` द्वारे समाविष्ट करणे `open-sse/utils/publicCreds.ts` मध्ये — **कधीही** स्ट्रिंग लिटरल्स म्हणून नाही. अनिवार्य नमुन्यासाठी `docs/security/PUBLIC_CREDS.md` पहा.
- **त्रुटी प्रतिसाद** (HTTP / SSE / कार्यान्वयन / MCP हँडलर): **आवश्यक** `buildErrorBody()` किंवा `sanitizeErrorMessage()` द्वारे मार्गक्रमण करणे `open-sse/utils/error.ts` मध्ये — **कधीही** कच्चा `err.stack` किंवा `err.message` प्रतिसाद शरीरात ठेऊ नका. `docs/security/ERROR_SANITIZATION.md` पहा.
- **परिवर्तनीयांवरून तयार केलेले शेल कमांड**: जेव्हा `exec()`/`spawn()` कॉल करताना स्क्रिप्टमध्ये रनटाइम मूल्ये आवश्यक असतात, तेव्हा `env` पर्यायाद्वारे पास करा (स्वयंचलितपणे शेल-एस्केप केले) — **कधीही** अविश्वसनीय/बाह्य पथ स्क्रिप्ट शरीरात स्ट्रिंग-इंटरपोलेट करू नका. संदर्भ: `src/mitm/cert/install.ts::updateNssDatabases`.
- **सुरक्षित-डिफॉल्ट लायब्ररी** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): नवीन सुरक्षा-संवेदनशील पृष्ठभाग जोडताना कस्टम अंमलबजावणीऐवजी Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink यांना प्राधान्य द्या.
---
## सामान्य सुधारणा परिस्थिती
### नवीन प्रदाता जोडणे
1. `src/shared/constants/providers.ts` मध्ये नोंदणी करा (लोडवर Zod-प्रमाणित)
2. जर कस्टम लॉजिक आवश्यक असेल तर `open-sse/executors/` मध्ये कार्यान्वयन जोडा (`BaseExecutor` विस्तारित करा)
3. जर नॉन-OpenAI फॉरमॅट असेल तर `open-sse/translator/` मध्ये अनुवादक जोडा
4. जर OAuth-आधारित असेल तर `src/lib/oauth/constants/oauth.ts` मध्ये OAuth कॉन्फिग जोडा — जर अपस्ट्रीम CLI सार्वजनिक client_id/secret पाठवत असेल, तर `resolvePublicCred()` द्वारे समाविष्ट करा (पहा `docs/security/PUBLIC_CREDS.md`), **कधीही** लिटरल म्हणून नाही
5. `open-sse/config/providerRegistry.ts` मध्ये मॉडेल्स नोंदणी करा
6. `tests/unit/` मध्ये चाचण्या लिहा (जर तुम्ही नवीन समाविष्ट केलेल्या डिफॉल्टसाठी सार्वजनिकCreds आकाराचे प्रमाणित केले तर समाविष्ट करा)
### नवीन API मार्ग जोडणे
1. `src/app/api/v1/your-route/` अंतर्गत निर्देशिका तयार करा
2. `GET`/`POST` हँडलर्ससह `route.ts` तयार करा
3. नमुना अनुसरण करा: CORS → Zod शरीर प्रमाणन → वैकल्पिक प्रमाणीकरण → हँडलर प्रतिनिधित्व
4. हँडलर `open-sse/handlers/` मध्ये जातो (तिथून आयात करा, इनलाइन नाही)
5. त्रुटी प्रतिसाद `buildErrorBody()` / `errorResponse()` वापरतात `open-sse/utils/error.ts` कडून (स्वयंचलितपणे स्वच्छ केले — कधीही `err.stack` किंवा `err.message` कच्चा शरीरात ठेऊ नका). `docs/security/ERROR_SANITIZATION.md` पहा.
6. चाचण्या जोडा — कमीत कमी एक प्रमाणन समाविष्ट करा की त्रुटी प्रतिसाद स्टॅक ट्रेस लीक करत नाही (`!body.error.message.includes("at /")`)
### नवीन DB मॉड्यूल जोडणे
1. `src/lib/db/yourModule.ts` तयार करा — `./core.ts` कडून `getDbInstance` आयात करा
2. तुमच्या डोमेन टेबलसाठी CRUD कार्ये निर्यात करा
3. नवीन टेबल आवश्यक असल्यास `src/lib/db/migrations/` मध्ये स्थलांतर जोडा
4. `src/lib/localDb.ts` कडून पुनः-निर्यात करा (फक्त पुनः-निर्यात यादीत जोडा)
5. चाचण्या लिहा
### नवीन MCP साधन जोडणे
1. Zod इनपुट स्कीमा + असिंक्रोनस हँडलरसह `open-sse/mcp-server/tools/` मध्ये साधन व्याख्या जोडा
2. साधन सेटमध्ये नोंदणी करा (`createMcpServer()` द्वारे वायर्ड)
3. योग्य स्कोपमध्ये नियुक्त करा
4. चाचण्या लिहा (साधन आवाहन `mcp_audit` टेबलमध्ये लॉग केले जाते)
### नवीन A2A कौशल्य जोडणे
1. `src/lib/a2a/skills/` मध्ये कौशल्य तयार करा (5 आधीच अस्तित्वात आहेत: स्मार्ट-रूटिंग, कोटा-व्यवस्थापन, प्रदाता-शोध, खर्च-विश्लेषण, आरोग्य-रिपोर्ट)
2. कौशल्य कार्य संदर्भ प्राप्त करते (संदेश, मेटाडेटा) → संरचित परिणाम परत करते
3. `src/lib/a2a/taskExecution.ts` मध्ये `A2A_SKILL_HANDLERS` मध्ये नोंदणी करा
4. `src/app/.well-known/agent.json/route.ts` मध्ये उघडा (एजंट कार्ड)
5. `tests/unit/` मध्ये चाचण्या लिहा
6. `docs/frameworks/A2A-SERVER.md` कौशल्य टेबलमध्ये दस्तऐवजीकरण करा
### नवीन क्लाउड एजंट जोडणे
1. `src/lib/cloudAgent/agents/` मध्ये `CloudAgentBase` विस्तारित करणारा एजंट वर्ग तयार करा (3 आधीच अस्तित्वात आहेत: codex-cloud, devin, jules)
2. `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources` कार्यान्वित करा
3. `src/lib/cloudAgent/registry.ts` मध्ये नोंदणी करा
4. आवश्यक असल्यास OAuth/क्रेडेन्शियल्स हाताळणी जोडा (`src/lib/oauth/providers/`)
5. चाचण्या + `docs/frameworks/CLOUD_AGENT.md` मध्ये दस्तऐवजीकरण करा
### नवीन गार्डरेल / इव्हॅल / कौशल्य / वेबहुक इव्हेंट जोडणे
- गार्डरेल: `src/lib/guardrails/` → दस्तऐवज: `docs/security/GUARDRAILS.md`
- इव्हॅल सूट: `src/lib/evals/` → दस्तऐवज: `docs/frameworks/EVALS.md`
- कौशल्य (सँडबॉक्स): `src/lib/skills/` → दस्तऐवज: `docs/frameworks/SKILLS.md`
- वेबहुक इव्हेंट: `src/lib/webhookDispatcher.ts` → दस्तऐवज: `docs/frameworks/WEBHOOKS.md`
## संदर्भ दस्तऐवज
कोणत्याही महत्त्वाच्या बदलासाठी, आधी संबंधित गहन अभ्यास वाचा:
| क्षेत्र | दस्तऐवज |
| ------------------------------------------ | ----------------------------------------------------------------- |
| रेपो नेव्हिगेशन | `docs/architecture/REPOSITORY_MAP.md` |
| आर्किटेक्चर | `docs/architecture/ARCHITECTURE.md` |
| अभियांत्रिकी संदर्भ | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
| ऑटो-कॉम्बो (9-फॅक्टर स्कोअरिंग, 14 धोरणे) | `docs/routing/AUTO-COMBO.md` |
| टिकाऊपणा (3 यांत्रिके) | `docs/architecture/RESILIENCE_GUIDE.md` |
| विचारणाचे पुनरावलोकन | `docs/routing/REASONING_REPLAY.md` |
| कौशल्यांचे फ्रेमवर्क | `docs/frameworks/SKILLS.md` |
| मेमरी प्रणाली (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
| क्लाउड एजंट्स | `docs/frameworks/CLOUD_AGENT.md` |
| गार्डरेल्स (PII / इंजेक्शन / दृष्टिकोन) | `docs/security/GUARDRAILS.md` |
| सार्वजनिक अपस्ट्रीम प्रमाणपत्र (जेमिनी/इ.) | `docs/security/PUBLIC_CREDS.md` |
| त्रुटी संदेश स्वच्छता | `docs/security/ERROR_SANITIZATION.md` |
| मूल्यांकन | `docs/frameworks/EVALS.md` |
| अनुपालन / ऑडिट | `docs/security/COMPLIANCE.md` |
| वेबहुक्स | `docs/frameworks/WEBHOOKS.md` |
| अधिकृतता पाईपलाइन | `docs/architecture/AUTHZ_GUIDE.md` |
| गुप्तता (TLS / फिंगरप्रिंट) | `docs/security/STEALTH_GUIDE.md` |
| एजंट प्रोटोकॉल (A2A / ACP / क्लाउड) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
| MCP सर्व्हर | `docs/frameworks/MCP-SERVER.md` |
| A2A सर्व्हर | `docs/frameworks/A2A-SERVER.md` |
| API संदर्भ + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
| प्रदाता कॅटलॉग (स्वयंचलित-निर्मित) | `docs/reference/PROVIDER_REFERENCE.md` |
| रिलीज प्रवाह | `docs/ops/RELEASE_CHECKLIST.md` |
---
## चाचणी
| काय | कमांड |
| ----------------------- | -------------------------------------------------------------- |
| युनिट चाचण्या | `npm run test:unit` |
| एकल फाइल | `node --import tsx/esm --test tests/unit/file.test.ts` |
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
| E2E (Playwright) | `npm run test:e2e` |
| प्रोटोकॉल E2E (MCP+A2A) | `npm run test:protocols:e2e` |
| इकोसिस्टम | `npm run test:ecosystem` |
| कव्हरेज गेट | `npm run test:coverage` (75/75/75/70 — विधान/रेषा/कार्ये/शाखा) |
| कव्हरेज रिपोर्ट | `npm run coverage:report` |
**PR नियम**: जर तुम्ही `src/`, `open-sse/`, `electron/`, किंवा `bin/` मध्ये उत्पादन कोड बदलला, तर तुम्हाला त्या PR मध्ये चाचण्या समाविष्ट करणे किंवा अद्यतनित करणे आवश्यक आहे.
**चाचणी स्तर प्राधान्य**: युनिट प्रथम → एकत्रीकरण (बहु-मॉड्यूल किंवा DB स्थिती) → e2e (UI/कार्यप्रवाह फक्त). बग पुनरुत्पादनांना स्वयंचलित चाचण्यांमध्ये कोडित करा, दुरुस्तीसह किंवा आधी.
**Copilot कव्हरेज धोरण**: जेव्हा PR उत्पादन कोड बदलतो आणि कव्हरेज 75% (विधान/रेषा/कार्ये) किंवा 70% (शाखा) खाली असते, तेव्हा फक्त अहवाल देऊ नका — चाचण्या जोडा किंवा अद्यतनित करा, कव्हरेज गेट पुन्हा चालवा, नंतर पुष्टीसाठी विचारा. चालवलेले कमांड, बदललेले चाचणी फाइल्स, आणि अंतिम कव्हरेज परिणाम PR अहवालात समाविष्ट करा.
---
## Git कार्यप्रवाह
```bash
# मुख्य शाखेत थेट कमिट करू नका
git checkout -b feat/your-feature
git commit -m "feat: describe your change"
git push -u origin feat/your-feature
```
**शाखा उपसर्ग**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
**कमिट स्वरूप** (परंपरागत कमिट्स): `feat(db): add circuit breaker` — स्कोप: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
**Husky हुक्स**:
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
- **pre-push**: `npm run test:unit`
---
## वातावरण
- **रनटाइम**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES मॉड्यूल
- **TypeScript**: 5.9+, लक्ष्य ES2022, मॉड्यूल esnext, रिझोल्यूशन बंडलर
- **पथ उपसर्ग**: `@/*``src/`, `@omniroute/open-sse``open-sse/`, `@omniroute/open-sse/*``open-sse/*`
- **डीफॉल्ट पोर्ट**: 20128 (API + डॅशबोर्ड एकाच पोर्टवर)
- **डेटा निर्देशिका**: `DATA_DIR` env var, डीफॉल्ट `~/.omniroute/`
- **महत्त्वाचे env vars**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
- सेटअप: `cp .env.example .env` नंतर `JWT_SECRET` (`openssl rand -base64 48`) आणि `API_KEY_SECRET` (`openssl rand -hex 32`) तयार करा
---
## कठोर नियम
1. कधीही गुप्त माहिती किंवा प्रमाणपत्रे कमिट करू नका
2. कधीही `localDb.ts` मध्ये लॉजिक जोडू नका
3. कधीही `eval()` / `new Function()` / implied eval वापरू नका
4. कधीही थेट `main` मध्ये कमिट करू नका
5. कधीही मार्गांमध्ये कच्चा SQL लिहू नका — `src/lib/db/` मॉड्यूल वापरा
6. कधीही SSE प्रवाहांमध्ये चुकांना गुपचूप गिळून टाका
7. नेहमी Zod स्कीमासह इनपुटची पडताळणी करा
8. उत्पादन कोड बदलताना नेहमी चाचण्या समाविष्ट करा
9. कव्हरेज ≥75% (विधान, रेषा, कार्ये) / ≥70% (शाखा) राहिले पाहिजे. वर्तमान मोजलेले: ~82%.
10. स्पष्ट ऑपरेटर मंजुरीशिवाय Husky हुक्स (`--no-verify`, `--no-gpg-sign`) बायपास करू नका.
11. कधीही सार्वजनिक अपस्ट्रीम OAuth client_id/secret किंवा Firebase वेब कीज स्ट्रिंग लिटरल म्हणून समाविष्ट करू नका — नेहमी `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`) द्वारे जा. पहा `docs/security/PUBLIC_CREDS.md`.
12. कधीही HTTP / SSE / कार्यकारी प्रतिसादांमध्ये कच्चा `err.stack` / `err.message` परत करू नका — नेहमी `buildErrorBody()` किंवा `sanitizeErrorMessage()` (`open-sse/utils/error.ts`) द्वारे मार्गदर्शित करा. पहा `docs/security/ERROR_SANITIZATION.md`.
13. कधीही बाह्य पथ किंवा रनटाइम मूल्ये `exec()`/`spawn()` कडे पाठवलेल्या शेल स्क्रिप्टमध्ये स्ट्रिंग-इंटरपोलेट करू नका — त्याऐवजी `env` पर्यायाद्वारे पास करा. संदर्भ: `src/mitm/cert/install.ts::updateNssDatabases`.
14. कधीही CodeQL / Secret-Scanning अलर्ट नाकारू नका (a) वर दिलेल्या पॅटर्न दस्तऐवजांची तपासणी न करता, आणि (b) नकारात्मक टिप्पणीत तांत्रिक कारणाची नोंद न करता. उदाहरण: `js/stack-trace-exposure` कॉलसाइटवर उभा राहिला आहे जो आधीच `sanitizeErrorMessage()` द्वारे मार्गदर्शित आहे, हे एक ज्ञात CodeQL मर्यादा आहे (कस्टम सॅनिटायझर्स ओळखले जात नाहीत) — `docs/security/ERROR_SANITIZATION.md` संदर्भित करून `false positive` म्हणून नकारा.
15. कधीही चाइल्ड प्रक्रियांचा स्पॉन करणारे मार्ग (`/api/mcp/`, `/api/cli-tools/runtime/`) समाविष्ट करू नका `src/server/authz/routeGuard.ts` मध्ये `isLocalOnlyPath()` वर्गीकरणाशिवाय. लूपबॅक अंमलबजावणी कोणत्याही प्रमाणीकरण तपासणीपूर्वी अनिवार्यपणे होते — टनलद्वारे गळती झालेला JWT प्रक्रिया स्पॉनिंगला ट्रिगर करू शकत नाही. पहा `docs/security/ROUTE_GUARD_TIERS.md`.
16. AI सहाय्यक, LLM किंवा स्वयंचलित खात्याला श्रेय देणारे `Co-Authored-By` ट्रेलर्स कधीही समाविष्ट करू नका (उदा. "Claude", "GPT", "Copilot", "Bot" असलेली नावे; `anthropic.com` / `openai.com` / बॉट-मालकीच्या `noreply.github.com` पत्त्यांवरील ईमेल). असे ट्रेलर्स GitHub वर बॉट खात्यात कमिट अॅट्रिब्यूशन रूट करतात, PR इतिहासात खऱ्या लेखकाला (`diegosouzapw`) लपवतात. मानवी सहयोगी — upstream PR लेखक आणि OmniRoute मध्ये पोर्ट केले जाणारे issue रिपोर्टर सह — मानक `Co-authored-by: Name <email>` ट्रेलर्ससह श्रेय मिळवू शकतात आणि मिळावे; upstream-port वर्कफ्लो (`/port-upstream-features`, `/port-upstream-issues`) यावर अवलंबून आहेत.