HyperoruDocumentation
Workflows

Audit lifecycle

Queue admission, deterministic scanning, context assembly, agent reasoning, reports, SSE progress, retries, and partial results.

  1. 01
    Ingest

    Capture an exact source snapshot or validate an uploaded artifact.

  2. 02
    Observe

    Extract deterministic code, dependency, IaC, and CI/CD facts.

  3. 03
    Reconcile

    Build tenant-scoped entities, edges, evidence, and contradictions.

  4. 04
    Reason

    Route bounded context to specialist agents and verify every claim.

  5. 05
    Deliver

    Publish architecture, findings, costs, and controlled remediation.

Admission and queueing

Audit creation requires workspace access, an authorized source, and an idempotency key. A workspace may have at most one active-or-queued audit. A duplicate request returns a typed conflict that identifies the existing audit rather than creating competing work.

The scheduler uses global scanner capacity and runner health to expose queue position. Queue state is persisted; it is not inferred from a browser connection.

Stage contract

StageDurable outputCan be partial?
Ingestionexact commit or validated upload snapshotno—invalid source stops admission
Scanningnormalized observations, SBOM, scanner coverageyes—each failed scanner creates a coverage gap
Reconciliationentities, relationships, evidence, contradictionsyes—missing source lowers confidence
Agent analysistyped artifacts with evidence IDsyes—budget or agent failure is explicit
Reportingcanonical Pydantic JSONyes—coverage and omitted stages are prominent
ExportMarkdown, DOCX, PDF, JSON, Mermaid/SVG/PNGformat-specific failure is retryable

Live events

Authenticated SSE emits monotonic events for queue position, stage transitions, scanner logs, agent artifacts, cost, cache decisions, warnings, retries, and terminal state. Clients reconnect with the last received event identifier and deduplicate by event ID.

queue.updated
audit.stage.started
scanner.log
agent.artifact.completed
usage.updated
audit.coverage_gap.created
audit.completed

Cancellation and retry

Cancellation stops new activities, requests cooperative termination of active work, and preserves evidence already committed. Retry creates or resumes only an allowed failed boundary; it does not silently overwrite the prior attempt or duplicate costs.

A partial report is a valid terminal outcome

Scanner failure, unavailable model budget, or an exhausted cost cap produces a report that names the missing coverage. It never produces a clean verdict by omission.

On this page