Documentation · v1.0.1

Learn BatchWeaver from evaluation to operations

This portal maps the complete source documentation. Use tutorials to learn, task guides to act, reference pages for exact contracts, architecture for design rationale, and limitations before adoption.

Start here

Evaluate safely

The recommended sequence is tutorial → module setup → scan → proof → plan → overlay test.

Verified batching tutorialComplete proof, preview, test, and rollback workflow. Use as a Go moduleInstall the CLI and import typed packages. Runtime APIExplicit request-scoped coalescing. Scan a workspaceProduce a deterministic candidate report. Prove candidatesEvaluate strategy-specific obligations. Plan a transformationReview source-anchored changes without writing.

Concepts

Understand the semantic model

Core contracts

Batching modelOperation contractsProof obligationsIsolation and partitioningResult semanticsDeduplication

Transformations

Transformation strategiesStatic loop prefetchRuntime call coalescingFan-out coalescingBatching barriersSource maps

Adaptive execution

Adaptive batchingShadow tuningSLO guardrailsRecursive breadth-first batchingFairness and quotasOverload control

Architecture

Follow each subsystem

System overviewEnd-to-end component map.Package boundariesPublic and internal dependency direction.Static analysisPackages, SSA, call graph, and effects.Proof engineObligations, witnesses, and certificates.Transformation pipelinePlans, anchors, diffs, and validation.Build overlaysNon-mutating builds and tests.Runtime engineCoordinator, queues, workers, and cancellation.Generated bridge ABITyped compiler/runtime boundary.Editor serviceLSP, daemon, buffers, and previews.Adaptive schedulerProfiles, cost model, and bounded control.Architecture decisions81 ADRs with rationale and tradeoffs.Threat modelsSecurity analysis for every major subsystem.

Task guides

Compiler, runtime, tuning, and rollout

Compiler workflow

Explain a rejectionBuild with overlaysEnable runtime loweringMaterialize and revert

Adaptive controls

Collect a profileAnalyze tuningEnable adaptive modeReplay a workloadConfigure fairnessHandle overload

Adoption

Team adoptionCI rolloutManual batching migrationDataLoader migrationProduction rollout

Adapters and protocols

Integrate explicit batch providers

Create an adapterManifest, provider, mapping, verification.database/sqlExact/composite-key PostgreSQL synthesis, bounded joins, and overlay plans.Redis contractsMGET, HMGET, pipeline, and cluster slots.HTTP and OpenAPIExplicit batch endpoint contracts.GraphQLOperation scope and resolver waves.gRPCExplicit batch RPC and metadata policy.

Concrete pgx, go-redis, gqlgen, and grpc-go packages are implemented on the default branch. Check the exact immutable release and compatibility status before adoption.

Editors

Live diagnostics and safe previews

VS CodeInstall the verified VSIX and configure sidecar/proxy mode.NeovimStandard LSP setup.Emacs/EglotStandard LSP setup.HelixLanguage server configuration.ZedCustom language server setup.gopls proxy modeCompose BatchWeaver and standard Go features.

Reference

Exact formats and compatibility contracts

Public contracts

Configuration schemaTyped declarationsProvider contractCancellation and deadlinesRuntime ABI

Compiler formats

Proof schemaTransformation schemaTool-exec integrationDiagnostic codesExit codes

Operations

Profile schemaAdaptive configurationTuning metricsDaemon protocolLSP capabilities

Security and limitations

Know the trust boundary before adoption

Security policyPrivate vulnerability reporting and supported channels.PrivacyNo source upload or prompt-free product telemetry.Threat modelsCompiler, runtime, adapters, profiles, and editor risks.Limitations indexUnsupported and deliberately excluded behavior.Known issuesVerified limitations and workarounds.Security reportCurrent security and supply-chain evidence.

Release and maintenance

Operate, verify, and contribute

CompatibilitySupported and tested environments.Release policyVersioning and authority.Release checklistFail-closed release gates.RollbackOperational recovery.Development setupBuild the repository.Quality gatesTests, race, lint, security, and release assurance.