mirror of
https://github.com/morluto/rea.git
synced 2026-11-18 20:53:00 +00:00
* fix(process): name the fields a located divergence compared `first_divergence` handed back the whole observation on each side, so a caller that saw `changed` had to diff two large objects by hand to learn what the comparison actually judged. Reported in #8204: the same deterministic CLI captured twice reports `terminal`, `exit`, and `filesystem` changed, and the report names no field. A located divergence now carries `fields`, the sorted leaf paths that differ in the projection the comparison judged, for example `files[3].path`, `pid`, `process_samples[0].pid`, or `$` when a whole observation is present on one side only. Positions are bracketed array indices; the list is bounded to eight names because the report names a difference rather than copying the observation, and `left` and `right` still retain both complete observations. The list is computed from the comparable projection, not the observed values, so capture-local timing (`at_ms`, `dispatched_at_ms`, `elapsed_ms`, `sent_at_ms`) is never named unless a `trace_spec` explicitly selects it. That keeps the names honest about what the comparison measured. Naming a volatile value is not a claim of equivalence. A per-run temporary root or PID still counts as a difference; the exclusion path remains capture-time normalization (`normalization.paths`, `normalization.pids`, `normalization.patterns`), which must match on both sides because comparison refuses captures under different rules. `fields` is optional in the contract. `readComparisonResult` re-validates `normalized_result` of authenticated Evidence, so a required field would reject records written before this change. Producing code always populates it. Validation: `tsc --noEmit` clean; `oxlint` reports only the four pre-existing complexity/length warnings this file already carried; `scripts/ci/static-check-report.mjs lint` 0 errors; module boundaries and architecture guards pass; `oxfmt --check` clean on the touched files; `completeness-enum-guard`, `optional-fact-default-guard`, and `rea-numeric-limits` pass; `scan:todos` and `verify-test-discovery` clean; jscpd within budget. 194 focused domain tests passed, including five new cases covering a temporary-path leaf inside a filesystem checkpoint, a fully populated process sample, the eight-name bound, one-sided presence as `$`, and an authenticated payload without `fields`. No live process capture was exercised on this host. Refs #8204 * fix(process): honor trace timing policy in divergence fields --------- Co-authored-by: morluto <76467478+morluto@users.noreply.github.com>
Documentation directory
REA documentation is organized by reader task and document owner. This directory
links every authored guide; the site also serves separate
product pages. The VitePress documentation source is this docs/ tree.
Getting started
- Installation and setup
- Client configuration and troubleshooting
- CLI and Evidence
- Guided MCP prompts and completion
Native binaries
- Native binary investigation
- Go binary build metadata
- DWARF compile units
- Offline binary diagnostics
- ELF separate debug files
- ELF and Mach-O initializer functions
- ELF unwind function ranges
- Linux kernel build config
- Recorded crash evidence
- CycloneDX dependencies
- Windows Shell Link shortcuts
- Acquired NTFS metadata and change journals
JavaScript and Electron
- JavaScript Application Graph
- Cross-layer JavaScript application workflows
- JavaScript artifact reconstruction
- JavaScript source recovery
- Passive Node and Electron runtime observation
- JavaScript static/runtime reconciliation
- Electron file-page observation
- V8 code cache inspection
Browser and captured websites
- Website observation with CDP
- Browser scenario contract
- Website runtime source attribution
- Historical web network captures
- HTTP/3 capture lab
- Captured website source locations
- Captured website module relationships
- Captured website scripts and static JavaScript analysis
Android applications
- Static Android APK analysis
- Apktool resource decoding
- ADB device inspection and acquisition
- Flutter build identification
Apple applications
.NET assemblies
Firmware
HarmonyOS packages
WebAssembly
EVM contracts
Databases and recorded packets
Process capture and instrumentation
Signal recordings
Provider setup and formats
- Ghidra provider semantics
- DOS MZ and COM analysis with Ghidra
- Optional NativeAOT metadata recovery
- MIPS ELF analysis through Ghidra
- PSP static ELF analysis through Ghidra
- RISC-V ELF analysis through Ghidra
- Windows Ghidra P0
- Headerless raw-binary analysis with Ghidra
- IDA provider
- JEB instrumentation and analysis
Contracts and evidence
Development and verification
- Settings and recovery
- REA limit inventory
- MCP tool design
- Testing REA
- Client and agent verification
- Reconstruction readiness conformance
- Releasing REA
- REA roadmap
Release migrations
Architecture and authoring
- Architecture map
- Documentation ownership and contribution model
- Feature specifications
- Architectural decision records
Machine-owned documentation
| Path | Owner and update command |
|---|---|
public/product-catalog.json |
Ignored contract projection; npm run docs:generate |
verification/managed-conformance-*.json |
Ignored managed conformance projections; npm run evidence:generate |
error-contract.schema.json |
Tracked schema from contracts; npm run docs:error-schema |
user-visible-errors.csv |
Generated error code and category per domain and provider-owned error case; npm run docs:error-schema |
releases/<version>.contributions.json |
Durable release contribution record; follow the release guide |
assets/ |
Shared authored images referenced by guides |
Do not edit generated catalogs or evidence to change product facts. Change their canonical contracts or producer and regenerate. Historical release records retain the exact commit messages and references from the release they describe.
Additional guides
- Offline API contract inventory
- Bun standalone executables
- Deno compile executables
- Capability composition and ownership
- .NET single-file bundles
- ESP flash images
- U-Boot FIT images
- Measure MCP catalog costs in Codex
- Offline Playwright traces
- Testing lanes and provider verification
- UF2 and DfuSe images
- WeChat mini-program wxapkg archives
- Binary hardening
- Desktop application capture
- Desktop application export
- Desktop application state
- Desktop application tasks
- Desktop build computer
- Desktop build witness
- iNES containers
- Build RL environments with REA
- Agent environments from recorded captures
- Android boot and vendor_boot images
- APK signature schemes
- Android OTA update payloads
- Apple IPS crash reports
- Static analysis in GitHub Actions
- Desktop installation directories
- Flattened devicetree inspection
- Electron fuse state
- ELF note tables
- ELF dependency tables
- Erlang BEAM files
- ESP images
- GameCube DOL analysis through Ghidra
- PowerPC ELF analysis through Ghidra
- Godot PCK archives
- Static CUDA and HIP code objects
- Intel HEX and S-record images
- IL2CPP metadata
- Static JavaScript route inventory
- Linux kernel modules
- Kuna provider
- Maven POM and Gradle module metadata
- Model file declarations
- Match native functions across builds
- Node.js single executable applications
- NuGet packages
- PE Authenticode certificate tables
- PE import and delay-load tables
- PE TLS callbacks and load configuration
- Python packaged applications
- CPython pyc inspection
- Reconstruction coverage
- Release exposure
- Reverse-engineering tool integrations
- Rust binary dependency metadata
- U-Boot legacy uImage containers
- UnityFS AssetBundle archives