3.9 KiB
Public Surface
This is the public OpenProse API and runtime map.
OSS: Local-First OpenProse
The Bun CLI covers authoring and local runtime:
prose compile: canonical.prose.md -> Prose IRprose manifest: readable/runtime projection from the canonical IRprose lint/prose fmt: canonical source hygieneprose highlight/prose grammar: syntax visibility and editor grammar artifactsprose preflight: environment, dependency, and runtime-profile readiness checks without secret valuesprose plan: stale/current/blocked reasoning against prior runsprose graph: graph rendering with plan overlayprose run: graph-VM local execution through the meta-harnessprose handoff: export a single component contract for a compatible one-off agent harnessprose eval: executable eval contracts over materialized runsprose remote execute: hosted-compatible envelope and artifact manifest, using the same graph-VM/runtime-profile vocabulary asprose runprose status/prose trace: inspect local runsprose package: generate package metadataprose publish-check: local publish gateprose search: local package discoveryprose install: install local or registry-addressed packages into.deps/
All commands use the same model:
.prose.mdsource- deterministic IR
- run materialization as the universal execution record
- deterministic
--outputfixtures as a development/test path, not the runtime center - Pi-backed graph VM execution with one persisted session per selected node
- intra-node child-session delegation through
openprose_subagent, retained as node-private state rather than graph output - structured output submission through
openprose_submit_outputs - structured node-session records in attempts and trace output
- package-local named JSON Schema validation for
Json<T>ports - package and hosted metadata as projections over the same executable contract
remote execute keeps deterministic --output fixtures for repeatable hosted
contract tests. Hosted workers can select --graph-vm pi and pass
--model-provider, --model, and --thinking flags, or provide the same Pi
runtime profile through environment variables.
Capabilities
The model gives agent workflows durable structure:
- typed ports improve composition and registry search
- package-local schemas make selected named port types executable contracts
- declared effects make planning and approvals legible
- prior-run comparison makes selective recompute possible
- graph/trace surfaces make the workflow inspectable
- package metadata makes sharing and publish discipline possible
Reference Packages
The repo carries three local packages:
examples/: concise, high-signal examples of the runtime modelpackages/std/: reusable primitivespackages/co/: company-operating-system starter patterns
The customers/prose-openprose reference company is a locally validated
package tree with publish-pass quality.
The examples/ package participates in release confidence through
measure:examples, confidence:runtime, deterministic scripted Pi scenarios,
and the skipped-by-default smoke:live-pi ladder.
Hosted Platform
The hosted platform consumes the same concepts the OSS package emits:
- package ingest
- hosted runs can be created and inspected
- persisted graph plans and graph snapshots
- approval recording and resolution
- the operator UI at
/ops/openprosecan inspect packages, runs, graphs, and approvals
Hosted surfaces use the same records:
- compiled components
- run records
- graph plans
- approvals
Platform Work
The local package has an executable runtime path and a repeatable confidence matrix. Platform work builds on that path:
- keep platform tests vendoring the OSS hosted-runtime fixtures directly so contract drift fails mechanically
- approval semantics and continuation behavior
- richer policy and provenance UX
- hosted publish/install UX
- tenant-aware registry and serving flows