Skip to content

README.md

Latest commit

 

History

History
76 lines (50 loc) · 3.03 KB

README.md

File metadata and controls

76 lines (50 loc) · 3.03 KB
Raw

Tools

Reusable software utilities for the Source Engineering discipline.

This repository holds the discipline's reusable tools. The tools are the discipline's user-facing surface.

Quick start

npm install
npm run build
node dist/cli/se-trace.js inspect path/to/cots.json

15-minute quickstart

Zero to a validated COTS in one command (Advancement Plan Phase 5 adopter quickstart):

bash scripts/quickstart.sh

It fetches (or falls back to the bundled) seed COTS, runs the quick conformance check, prints the inspect/cite summaries, and renders the COTS Explorer page. See source-engineering-education/quickstart-15-minutes.md for the guided version.

Commands

# Inspect a COTS
se-trace inspect examples/legal-summarization.cots.json

# Cite a specific decision (print the evidence chain)
se-trace cite examples/legal-summarization.cots.json urn:source-engineering:decision:...

# Visualize a COTS as a Reasoning Roadmap (Mermaid + HTML)
se-trace visualize examples/legal-summarization.cots.json -o ./out

# Quick conformance check
se-trace validate examples/legal-summarization.cots.json

# Surface the Layer 2 (Runtime Validation) record of a COTS (RFC-0001)
se-trace validate-runtime examples/legal-summarization.cots.json

# Walk the evidence chains and surface recursive (model-generated) items (RFC-0002)
se-trace recursive examples/legal-summarization.cots.json

# Print each decision's Layer 3 GuardrailDecision; re-evaluate against a rule file (RFC-0003)
se-trace check-guardrails examples/legal-summarization.cots.json
se-trace check-guardrails examples/legal-summarization.cots.json --rules rules.gr

What is in this repository

  • src/inspect.ts - the inspect command. Prints a human-readable summary of a COTS.
  • src/cite.ts - the cite command. Prints the evidence chain for a specific decision.
  • src/visualize.ts - the visualize command. Renders a COTS as a Mermaid diagram + HTML page.
  • src/cli/se-trace.ts - the CLI entry point, including validate-runtime (RFC-0001), recursive (RFC-0002), and check-guardrails (RFC-0003).
  • src/guardrails/layer3.ts - a thin consumer-side port of the reference implementation's Layer 3 for check-guardrails --rules re-evaluation.
  • tests/tools.test.ts - the test suite.

SDKs

The sdks/ directory is reserved for typed-language SDKs (TypeScript, Python). Skeletons land in P3 follow-on; the conformance suite and reference implementation are the canonical sources.

Relationship to other repos

  • Source-Engineering/source-engineering-conformance - the canonical conformance test suite. se-trace validate is a quick subset; the full suite is in source-engineering-conformance.
  • Source-Engineering/source-engineering-reference-implementation - the reference framework that produces COTSs.
  • Source-Engineering/source-engineering-specifications - the COTS schema the tools read.

Status

This is the tools slice (Phase 3). The se-trace CLI and the visualizer are working. SDK skeletons land in P3 follow-on.

License

Apache-2.0. See LICENSE.