manifest.json

{
  "version": 2,
  "sizeBudgetLines": 600,
  "generatedPaths": [
    "gui/dist"
  ],
  "absentPaths": [
    {
      "path": "go/",
      "reason": "the Go native-runtime experiment is retired; ops/docs-and-release.md documents that no go/ tree is tracked"
    }
  ],
  "tiers": [
    {
      "id": 1,
      "name": "Foundation",
      "purpose": "What opencodex is, what it owns on disk, and the invariants nothing may break."
    },
    {
      "id": 2,
      "name": "Configuration and catalog",
      "purpose": "Persisted config, the Codex home it writes into, and the model catalog it publishes."
    },
    {
      "id": 3,
      "name": "Data planes and transports",
      "purpose": "The wire surfaces a client actually talks to."
    },
    {
      "id": 4,
      "name": "Providers and adapters",
      "purpose": "Per-vendor contracts and the adapter authority that constructs them."
    },
    {
      "id": 5,
      "name": "Surfaces and clients",
      "purpose": "The dashboard, the management API, and third-party client config ownership."
    },
    {
      "id": 6,
      "name": "Operations and process",
      "purpose": "Background service, docs, release, and design discipline."
    }
  ],
  "docs": [
    {
      "path": "overview.md",
      "tier": 1,
      "title": "Overview",
      "scope": "Product boundary, local state ownership, and the non-negotiable invariants index.",
      "documents": [
        "gui/",
        "scripts/",
        "src/config.ts",
        "src/lib/"
      ]
    },
    {
      "path": "runtime.md",
      "tier": 1,
      "title": "Runtime",
      "scope": "Entrypoints, process lifecycle, CLI surface, and provider/adapter selection.",
      "documents": [
        "bin/",
        "src/adapters/",
        "src/chat/",
        "src/claude/",
        "src/cli.ts",
        "src/cli/",
        "src/client/",
        "src/codex/",
        "src/combos/",
        "src/compatibility/",
        "src/config.ts",
        "src/config/",
        "src/generated/",
        "src/github/",
        "src/grok/",
        "src/images/",
        "src/index.ts",
        "src/lab/",
        "src/lib/",
        "src/oauth/",
        "src/providers/",
        "src/reasoning-effort.ts",
        "src/remote/",
        "src/responses/",
        "src/router.ts",
        "src/server/",
        "src/service.ts",
        "src/service/",
        "src/stall-timeout.ts",
        "src/storage/",
        "src/tray/",
        "src/types.ts",
        "src/update/",
        "src/usage/",
        "src/vision/",
        "src/web-search/"
      ]
    },
    {
      "path": "config.md",
      "tier": 2,
      "title": "Config Surface",
      "scope": "Persisted config schema, both injection forms, provider validation, and restore.",
      "documents": [
        "src/cli/",
        "src/codex/",
        "src/config.ts",
        "src/config/",
        "src/types.ts"
      ]
    },
    {
      "path": "codex-home.md",
      "tier": 2,
      "title": "Codex Home",
      "scope": "CODEX_HOME resolution, the files opencodex manages there, and Codex-home diagnostics.",
      "documents": [
        "src/codex/"
      ]
    },
    {
      "path": "catalog.md",
      "tier": 2,
      "title": "Model Catalog",
      "scope": "Shared Codex catalog assembly, account namespaces, pool rotation, and effort ladders.",
      "documents": [
        "src/codex/",
        "src/routing/",
        "src/server/"
      ]
    },
    {
      "path": "subagents.md",
      "tier": 2,
      "title": "Subagents And Multi-Agent Surface",
      "scope": "Multi-agent surface mode and subagent roster ordering.",
      "documents": [
        "src/codex/",
        "src/providers/",
        "src/server/"
      ]
    },
    {
      "path": "transports/byte-accounting.md",
      "tier": 3,
      "title": "Byte Accounting",
      "scope": "Request-copy and stream-buffer byte accounting shared by parsing, SSE rewriting, the adapters, and the translator budget.",
      "documents": [
        "src/adapters/",
        "src/lib/",
        "src/server/"
      ]
    },
    {
      "path": "transports/responses.md",
      "tier": 3,
      "title": "Responses Transport",
      "scope": "The Responses HTTP/SSE data plane, combo failover, and streaming commit boundaries.",
      "documents": [
        "src/adapters/",
        "src/lib/",
        "src/responses/",
        "src/server/"
      ]
    },
    {
      "path": "transports/streaming-health.md",
      "tier": 3,
      "title": "Streaming Health And WebSocket",
      "scope": "Heartbeat and stall deadlines, plus the opt-in WebSocket transport.",
      "documents": [
        "src/server/"
      ]
    },
    {
      "path": "transports/inventory.md",
      "tier": 3,
      "title": "Transport Inventory",
      "scope": "The per-provider transport table and diagnostic outbound safety.",
      "documents": [
        "src/adapters/",
        "src/chat/",
        "src/images/",
        "src/lib/",
        "src/oauth/",
        "src/providers/",
        "src/server/"
      ]
    },
    {
      "path": "data-planes/images.md",
      "tier": 3,
      "title": "Images Data Plane",
      "scope": "Standalone image generation and edit relay.",
      "documents": [
        "src/server/"
      ]
    },
    {
      "path": "data-planes/search.md",
      "tier": 3,
      "title": "Search Data Plane",
      "scope": "Hosted search relay and exact account selectors.",
      "documents": []
    },
    {
      "path": "data-planes/inbound-compat.md",
      "tier": 3,
      "title": "Inbound Compatibility Surfaces",
      "scope": "Chat Completions inbound, Anthropic-shaped clients, and JSON-upstream streaming clients.",
      "documents": [
        "src/adapters/",
        "src/chat/",
        "src/server/"
      ]
    },
    {
      "path": "providers/openai-tiers.md",
      "tier": 4,
      "title": "OpenAI Provider Account Modes",
      "scope": "Pool/Direct account modes, API-key separation, wire identity, and quota evidence.",
      "documents": [
        "src/codex/",
        "src/config.ts"
      ]
    },
    {
      "path": "providers/cursor.md",
      "tier": 4,
      "title": "Cursor Provider",
      "scope": "Cursor native exec, parameterized models, checkpoints, and active-context usage.",
      "documents": [
        "src/adapters/"
      ]
    },
    {
      "path": "providers/google.md",
      "tier": 4,
      "title": "Google Provider",
      "scope": "Gemini thought-text, response parts, thought-signature replay, and adjacency repair.",
      "documents": []
    },
    {
      "path": "providers/kiro.md",
      "tier": 4,
      "title": "Kiro Provider",
      "scope": "Kiro parallel-tool hints, Responses text controls, and reasoning round-trip.",
      "documents": [
        "src/responses/"
      ]
    },
    {
      "path": "providers/xai-grok.md",
      "tier": 4,
      "title": "xAI Grok Provider",
      "scope": "Grok Build contract parity and hardening.",
      "documents": [
        "src/oauth/",
        "src/providers/",
        "src/responses/",
        "src/server/"
      ]
    },
    {
      "path": "providers/chat-compat.md",
      "tier": 4,
      "title": "Chat Provider Compatibility",
      "scope": "Cross-vendor Chat Completions behavior: reasoning, tool results, structured output, parallel tools.",
      "documents": [
        "src/adapters/",
        "src/responses/"
      ]
    },
    {
      "path": "adapters/registry.md",
      "tier": 4,
      "title": "Adapter Registry Authority",
      "scope": "The single adapter construction authority and contract inheritance.",
      "documents": [
        "src/adapters/",
        "src/server/"
      ]
    },
    {
      "path": "adapters/compatibility-contracts.md",
      "tier": 4,
      "title": "Compatibility Contracts",
      "scope": "Versioned provider compatibility claims and fixture-evidence boundaries.",
      "documents": [
        "src/compatibility/"
      ]
    },
    {
      "path": "adapters/compatibility-lab.md",
      "tier": 4,
      "title": "Compatibility Lab",
      "scope": "Optional Lab evidence, automation, and its core-runtime isolation boundary.",
      "documents": [
        "src/lab/"
      ]
    },
    {
      "path": "gui-and-management-api.md",
      "tier": 5,
      "title": "GUI And Management API",
      "scope": "Dashboard serving, authentication boundaries, /api/* ownership, and usage accounting.",
      "documents": [
        "gui/",
        "src/codex/",
        "src/lib/",
        "src/server/",
        "src/usage/",
        "src/vision/"
      ]
    },
    {
      "path": "clients/integrations.md",
      "tier": 5,
      "title": "Client Integrations",
      "scope": "Third-party client config ownership, snapshots, refresh, disable, and restore.",
      "documents": [
        "src/clients/",
        "src/integrations/",
        "src/lib/"
      ]
    },
    {
      "path": "clients/claude-desktop.md",
      "tier": 5,
      "title": "Claude Desktop Integration",
      "scope": "Claude Desktop profile ownership and config-library resolution.",
      "documents": [
        "src/claude/",
        "src/cli/",
        "src/client/",
        "src/server/"
      ]
    },
    {
      "path": "ops/service-and-sidecars.md",
      "tier": 6,
      "title": "Background Service And Sidecars",
      "scope": "Service install/repair, platform launchers, tray, and sidecar processes.",
      "documents": [
        "src/server/"
      ]
    },
    {
      "path": "ops/docs-and-release.md",
      "tier": 6,
      "title": "Docs And Release",
      "scope": "Docs site, workflow map, branch policy, release flow, and cross-platform CI.",
      "documents": [
        ".github/",
        "bin/",
        "docs-site/",
        "scripts/",
        "src/cli.ts",
        "src/cli/",
        "src/codex/",
        "src/lib/",
        "src/service.ts"
      ]
    },
    {
      "path": "design-methodology.md",
      "tier": 6,
      "title": "Design Methodology For New Surfaces",
      "scope": "Stage ordering for new GUI, CLI, and user-facing surfaces.",
      "documents": [
        "gui/"
      ]
    },
    {
      "path": "remote-workspace.md",
      "tier": 3,
      "title": "Remote Workspace",
      "scope": "Opt-in workspace identity, executor grants, runtime adapters, management and dashboard integration.",
      "documents": [
        "src/remote-control/"
      ]
    }
  ],
  "grace": {
    "undocumentedSourceAreas": [
      {
        "path": "src/bridge.ts",
        "reason": "no doc names this file; it is the legacy adapter bridge entry and its behavior is described under the adapter registry without a path reference"
      },
      {
        "path": "src/bridge/",
        "reason": "no doc names this directory; it holds the leaves moved out of the src/bridge.ts facade and inherits the same adapter-registry description the facade has"
      },
      {
        "path": "src/quota/",
        "reason": "no doc names a path here; quota evidence is described in providers/openai-tiers.md in prose only"
      },
      {
        "path": "src/service-manager-probe.ts",
        "reason": "no doc names this file; service probing is described in ops/service-and-sidecars.md without a path reference"
      },
      {
        "path": "src/sidecar/",
        "reason": "no doc names a path here; ops/service-and-sidecars.md describes sidecar behavior in prose only"
      },
      {
        "path": "src/types/",
        "reason": "shared declarations plus the tool-name and wire-pin resolvers, which no doc currently describes"
      }
    ],
    "unboundInvariants": [
      {
        "id": "INV-HOME-01",
        "reason": "no test asserts CODEX_HOME precedence over ~/.codex directly; the closest coverage is WSL home discovery"
      },
      {
        "id": "INV-SLUG-01",
        "reason": "no test constrains routed slug shape; the ten files that mention provider/model consume slugs rather than enforcing the form"
      }
    ],
    "oversizeDocs": [
      "gui-and-management-api.md",
      "providers/openai-tiers.md",
      "transports/responses.md"
    ],
    "staleRefs": []
  }
}