Navigation
ManualIntroductionGetting StartedBuilder SpecsOperationsPrograms And ViewsDesigning Builder SurfacesOutputs, Evidence, And Runtime ArtifactsMaterialization ModelAuthoring Production Builders
TheoryBuilders As DescriptionsInternalized ProgramsOrnaments And Domain SurfacesInterpretation And ViewsEvidence, Descriptors, And Runtime Structure
ExamplesNode service exampleSource filesNode service builder moduleserver.jsC code generation exampleSource filesC codegen builder modulemessages.defmain.cBridge exampleSource filesBridge proof moduleIDL exampleSource filesIDL builder moduleschema.protoOCI image exampleSource filesOCI image example module
API Reference
Core APIDescriptionsOperations
ProgramValidateDepsDry-runPlan-viewDescribeIntrospectMaterializeBackendsFormerPlan-export
ReferenceSchemasDatatypes
OrnamentsProject-builderDependenciesImplementationsToolEnvTestingVendoringCode-genIdlCapabilitiesProtocolServiceReplServerSandboxTransformOci-image
Library HelpersTool-envToolchainPassthruBundledDashboardContentAddress

Manual

Practical guidance for writing and using metaBuilder builders as typed descriptions with reusable program views.

metaBuilder is a library for writing builders as typed descriptions. A builder names the structure of a build. That structure includes inputs, tools, operations, outputs, runtime shape, and evidence, so the same build can be validated, inspected, explained, and materialized.

Use this manual when you want to design or consume a metaBuilder builder. It keeps the focus on the public model. You will see which values you write, which views you ask for, and how those views make a builder easier to understand.

Path Through The Manual

Start with Introduction for the overall model. Then read Getting Started for the smallest complete flow.

The middle chapters explain the reusable pieces.

The final chapters explain how to return useful artifacts and grow a small builder into a production builder.

For complete guided examples, read the examples section after the manual.

Introduction
metaBuilder treats builders as typed descriptions, giving one build reusable validation, inspection, documentation, and materialization views.
Getting Started
Define a small builder spec, construct a program, and run validate, dry-run, plan-view, introspect, and materialize.
Builder Specs
Builder specs name parameters, inputs, dependencies, tools, operations, outputs, and evidence before materialization.
Operations
Operations describe build intent as data: read inputs, declare tools, write files, run commands, emit descriptors, and materialize.
Programs And Views
The same builder program supports validation, dependency graph, dry-run, plan-view, describe, introspect, and materialization.
Designing Builder Surfaces
Design builders from domain vocabulary first, then lower small public constructors into the shared metaBuilder program model.
Outputs, Evidence, And Runtime Artifacts
Outputs, descriptors, evidence, services, protocols, and runtime units describe what an artifact is and how it should run.
Materialization Model
Materialization interprets a builder program as a plan that produces derivations, outputs, and runtime declarations.
Authoring Production Builders
Grow production builders from small domain constructors, explicit descriptors, standard views, and view-focused tests.