# Schematics

> Schematics is an experimental, pre-1.0 Effect-native config-as-code control plane for external APIs and SaaS resources. Try the browser playground at https://schematics.run/playground, or clone the public repository and run `pnpm install --frozen-lockfile` followed by `pnpm dev`; Schematics packages are private and are not published to npm.

The shipped playground has schema-routed documents, live validation and relation diagnostics, a schema-driven editor, agent tools and patch review, and a pull/plan/apply loop against example providers. Chat falls back to a deterministic debug responder when no model key is configured. Breaking changes are expected during the resource/document vocabulary migration.

The Astro-generated landing page also introduces the independent Schema Reflection library family. Its interactive landing demos are simulations built with Foldkit and Foldworks, loaded as their panels approach the viewport; package availability differs. Schematics consumes algebra from npm today. Further Schema Reflection adoption, Triplex persistence, and WorldVM integration are future work. WorldVM owns durable Program execution; Schematics owns external-resource providers, planning, review, and apply. Use the Schematics guides below for this repository's current implementation.

## Try it

- [Canonical site](https://schematics.run/): Library overview and browser playground entry point.
- [README](https://raw.githubusercontent.com/bjacobso/schematics/main/README.md): Current capabilities, maturity, WorldVM family fit, Schema Reflection library status, and local setup commands.

## Guides

- [Architecture and family boundaries](https://raw.githubusercontent.com/bjacobso/schematics/main/docs/architecture-constellation.md): Schematics ownership, Schema Reflection adoption, the distinction from WorldVM Program execution, and planned persistence integrations.
- [Consuming Schematics](https://raw.githubusercontent.com/bjacobso/schematics/main/docs/consuming-schematics.md): Source-linking the private workspace packages and building a consumer CLI or frontend; npm publication is future work.
- [Provider DSL](https://raw.githubusercontent.com/bjacobso/schematics/main/docs/provider-dsl-providers.md): Resource and provider composition, mock transports, project configs, and the minimal toy example.
- [Deploy CLI](https://raw.githubusercontent.com/bjacobso/schematics/main/docs/deploy-cli.md): Pull, plan, apply, destroy, filesystem layout, and approval flags for external resources.
- [Deployment modes](https://raw.githubusercontent.com/bjacobso/schematics/main/docs/architecture-deployment-modes.md): Local, in-memory, and hosted runtime topology and data boundaries.

## Schema Reflection libraries

- [Algebra](https://schematics.run/packages/algebra/): Published relationship annotations, graph extraction, diagnostics, and application composition patterns.
- [Predicates](https://schematics.run/packages/predicates/): Published schema-defined conditions, interpreters, rule explanations, and adoption guidance.
- [Logic](https://schematics.run/packages/logic/): Published inspectable actions, in-memory tests, execution services, and the distinction from experimental portable APIs.
- [Workflow](https://schematics.run/packages/workflow/): Source-only sequential process prototype, checkpoint transitions, host responsibilities, and composition.
- [Core](https://schematics.run/packages/core/): Source-only portable contract subset and expressions; distinct from the Schematics runtime package.
- [Filesystem](https://schematics.run/packages/filesystem/): Proposed layout, routing, and cross-file validation; specification-only with no shipped runtime.

## Contributing and family

- [Contributing](https://raw.githubusercontent.com/bjacobso/schematics/main/CONTRIBUTING.md): Repository verification and contribution conventions.
- [WorldVM](https://worldvm.com): The family hub for these independent research experiments.