Documentation

Everything you need to adopt `contract-kit` from scratch: first install, contract modeling, generation flow, and release safety checks.

Who this is for

• Frontend + backend teams that want one typed API source of truth.
• Tech leads who need predictable release checks for API compatibility.
• Developers integrating Angular clients with backend handlers without manual type drift.

Recommended first path

Step 1

Get running in minutes

Install the package, scaffold a project, and execute your first generation/check cycle.

Open Quickstart

Step 2

Understand command behavior

Learn what each CLI command does, when to run it, and what output to expect.

Open CLI Reference

Step 3

Model your API contracts

Define endpoint schemas correctly so generation and compatibility checks stay deterministic.

Open Contract Schema

Package map

@fr4n0m/contract-kit

Main CLI package for init/generate/check/validate/mock workflows.

Use directly in app repos or CI pipelines.

@fr4n0m/core

Contract parser + deterministic summary/model generation core.

Use when building custom tooling around contract processing.

@fr4n0m/contract-diff

Reusable compatibility diff engine between generated summaries.

Use in release automation, custom guards, and reporting integrations.

@fr4n0m/plugin-nestjs + @fr4n0m/validator-zod

Backend scaffolding and runtime schema validation outputs.

Use when wiring generated contracts into NestJS and validation middleware.

Sections

• Quickstart
• CLI Reference
• Contract Schema
• Generators
• Examples
• Contributing
• FAQ

Need support or want to report an issue? Use GitHub issues in the repository.