OpenRemap Documentation
Welcome to the OpenRemap wiki. Start at Getting started, then follow the five-minute path.
Getting started
| Document | Description |
|---|---|
| Getting started — home | Who this is for, the five-minute path, command map |
| About OpenRemap | What the project does, why it is open source, FAQ |
| Setup | Install, verify, update, develop, troubleshoot |
| Quick start | The five-minute path — identify, health, scan, cook, tune |
| CLI reference | All commands at a glance with examples |
| Interactive TUI | The graphical terminal interface — panels, shortcuts, file dialogs |
| Install guides | Windows, macOS/Linux, developers |
Concepts
| Document | Description |
|---|---|
| How it works | The full pipeline, step by step — identify → health → checksum → cook → merge → tune → validate → audit |
| Confidence scoring | How identification confidence tiers, signals, and warnings work |
| Evidence | How OpenRemap explains its results — detection tags, signals, labels, provenance |
| Recipe format | The .remap file spec (schema 4.4) — fields, structure, maps layer |
| Decoders | The CPU decoders — code references, the detection cascade, the decoder tag |
| Architecture | How the pieces connect — domains, extractor registry, Rust core |
| Tune format (.orst) | Deprecated — kept for reference |
API
| Document | Description |
|---|---|
| API — the programmatic surface | What openremap.api is, the three ways to call a method, and the pages of this section |
| API concepts | The method registry, input schemas, the three kinds, error codes |
| Workflows | Declarative .toml pipelines that chain methods |
| Transport (JSON-RPC) | The wire protocol over stdio — call the API from any language |
| Reference | The complete method catalogue |
Commands
Every command has a plain-English intro, a CLI reference and an
API page — each at its own top-level page (identify, cook,
tune, …). For the full list see the
CLI reference; new to the three surfaces? See
CLI, API & RPC.
Manufacturers
| Manufacturer | Families | Internals |
|---|---|---|
| Bosch | 19 extractors — EDC1 through MD1 (incl. ME7.9.x), per-family pages | Bosch internals |
| Siemens | 8 families — Simtec 56, SIMOS, PPD, SID801/803, EMS2000, MS43, GS20 | Siemens internals |
| Delphi | 2 families — Multec, Multec S | |
| Magneti Marelli | 4 families — IAW 1AV/1AP/4LV, MJD 6JF | |
| Denso | 4 families — 68HC16Y5, SH7055, SH7058, EE20 diesel | Subaru applications |
| Hitachi | 1 family — SH72546 | Subaru applications |
Project
| Document | Description |
|---|---|
| Contributing | How to add an extractor, code style, PR process |
| Release notes | What's new in recent versions — full history on GitHub |
| Disclaimer | Legal, safety, and intended use |
| Third-party credits | Community projects and ground truth behind the checksums |
| License | MIT License |