OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

Compatibility

Supported runtimes, frameworks, and agent modes for ContractSpec.

Runtimes

  • Node.js 20+

  • Bun 1.0+

Frameworks

  • Next.js 14+ (App Router preferred)

  • Bun + Elysia or compatible HTTP servers

Package managers

  • bun (recommended)

  • npm

  • pnpm

AI agent modes

  • claude-code

  • openai-codex

  • cursor

  • opencode

  • simple (direct LLM)

Datastores

ContractSpec ships with Prisma-friendly defaults and can integrate with custom adapters for other databases.

  • PostgreSQL via Prisma

  • Custom adapters for other SQL/NoSQL stores

Cross-platform UI architecture

Need the React and React Native component compatibility story? Read Cross-platform UI for the runtime and UI-layer split.

Start hereTroubleshootingNext: Installation
OSS docsstartStart with OSS. Adopt Studio when you want the operating layer.
Previous

Hello world

Define a first operation, generate the surface, and verify the end-to-end loop.

Next

Developer tools

Use the CLI, editors, and helper tooling that make the OSS workflow practical day to day.

Why ContractSpec

Keep educational and comparison content reachable without letting it define the primary OSS learning path.

ManifestoContract-first APISpec-driven development