sr8 1.2.4

SR8 local-first intent compiler

SR8

SR8 is a local-first intent compiler for AI systems. It turns weakly structured requests into canonical, inspectable artifacts and governed derivative outputs.

Automation map: assets/badges/README_BADGES.md

What SR8 Is

SR8 is the product layer. It compiles intent into a typed canonical artifact with:

• deterministic ingest, normalization, extraction, and assembly
• profile overlays and validation
• transform outputs, including markdown derivatives and XML package surfaces
• local storage, receipts, and catalog indexing
• diff and lint quality gates
• chat-frontdoor intake that still terminates in the canonical artifact path

Why SR8 Exists

Teams often need a repeatable way to convert intent into structured artifacts without relying on external services. SR8 provides that path with a local-first workflow that is easy to test, automate, and audit.

At the category layer, SR8 is the working proof of governed artifact infrastructure: intent becomes typed artifacts, validation results, lineage, and package outputs instead of disappearing into opaque prompt chains.

At the system horizon, SROS v2 remains the broader governed execution substrate. This repository does not claim to ship that full runtime.

Install

SR8 requires Python 3.11 or newer.

python -m pip install -e .
python -m pip install -e ".[dev]"

SR8 also supports repo-root .env and .env.local files for local settings and provider secrets. Start from .env.example and keep real secrets out of git.

For full local product verification:

cd frontend
npm ci

Install guide: docs/install.md

Quickstart

First success path:

sr8 init
sr8 compile examples/product_prd.md --profile prd --out ./.sr8/artifacts/canonical/
sr8 transform ./.sr8/artifacts/canonical/latest.json --to markdown_prd --out ./.sr8/artifacts/derivative/
sr8 lint ./.sr8/artifacts/canonical/latest.json
sr8 diff tests/fixtures/diff/base_artifact.json tests/fixtures/diff/changed_artifact.json
sr8 list

Core Concepts

• Canonical artifact: source of truth for compiled intent.
• Profile overlay: applies profile constraints and validation semantics.
• Derivative artifact: rendered output from canonical input.
• Receipt: machine-readable record of compile or transform persistence.
• Catalog: local index for artifact lookup and listing.

More detail: docs/index.md

CLI Overview

sr8 --help
sr8 version
sr8 init
sr8 compile <source> [--profile <profile>] [--source-type text|markdown|json|yaml]
sr8 validate <artifact-path> [--profile <profile>]
sr8 inspect <artifact-or-source>
sr8 transform <artifact-path> --to <target> [--out <dir>]
sr8 diff <left-artifact-or-id> <right-artifact-or-id>
sr8 lint <artifact-or-id>
sr8 list [--kind canonical|derivative] [--profile <profile>] [--path <workspace>]
sr8 show <record-or-artifact-id> [--path <workspace>]

Full reference: docs/cli-reference.md

Release Position

• Product: SR8 is an intent compiler for AI systems.
• Category: SR8 is the first working proof of governed artifact infrastructure in this repository.
• Horizon: SROS v2 is the larger governed execution direction, not the shipped runtime in this repo.

Python API Overview

Minimal compile usage:

from sr8.compiler import CompileConfig, compile_intent

result = compile_intent(
    source="examples/founder_ask.md",
    config=CompileConfig(profile="generic"),
)

artifact = result.artifact
print(artifact.artifact_id, artifact.validation.readiness_status)

FastAPI app entrypoint:

from sr8.api import app

More detail: docs/python-api.md API exposure guidance: docs/public-api-exposure.md

Profiles

Built-in profiles:

• generic
• prd
• repo_audit
• plan
• research_brief
• procedure
• media_spec
• prompt_pack
• whitepaper_outline
• code_task_graph

Reference: docs/profiles.md

Transforms

Built-in transform targets:

• markdown_prd
• markdown_plan
• markdown_research_brief
• markdown_procedure
• markdown_prompt_pack

Reference: docs/transforms.md

Storage and Receipts

Default workspace layout:

• .sr8/artifacts/canonical/
• .sr8/artifacts/derivative/
• .sr8/receipts/compile/
• .sr8/receipts/transform/
• .sr8/index/catalog.json

Reference: docs/storage-and-receipts.md

Diff and Lint

• sr8 diff compares semantic fields and classifies impact.
• sr8 lint runs explicit lint rules and returns a structured report.

Reference: docs/diff-and-lint.md

Contributing

See CONTRIBUTING.md for setup, quality gates, extension authoring, and PR expectations.

Security

See SECURITY.md and docs/security.md.

Roadmap

See ROADMAP.md.

Project Status

SR8 is a hardened local-first compiler release with extraction trust, provider portability, chat-frontdoor intake, XML package outputs, breadth registries, local product surfaces, and OSS-grade automation rails.

Release Notes

See CHANGELOG.md and docs/release-automation.md.