Counterfact turns an OpenAPI document into a useful local API in one command.
The published package and canonical user documentation live in
packages/counterfact.
- Start with the beginner guide
- Install and use Counterfact
- Browse documentation by task
- Contribute
- Review architecture decisions
This repository is a Yarn workspace monorepo. Its root package is private and coordinates builds, tests, releases, examples, and the documentation site.
Focused workspace packages:
@counterfact/client— reusable, OpenAPI-aware HTTP requests without the simulator or REPL.@counterfact/generator— route scaffolds, generated TypeScript contracts, scenarios, and compatible shared templates.@counterfact/openapi— standalone OpenAPI loading, bundling, dereferencing, and overlays.@counterfact/repl— an embeddable Node.js REPL over focused client and runtime contracts.@counterfact/runtime— route dispatch, registries, validation, hot reload, proxying, and Koa/MSW adapters.@counterfact/types— shared TypeScript contracts used by Counterfact internals and generated handlers.