CLI Reference

Full reference for the openremap command-line interface. For interactive use, just run openremap with no arguments to launch the TUI.

No server, no database, no internet connection required — install and run anywhere.

New to the terminal? Run openremap workflow first. It prints a complete plain-English walkthrough with the exact commands to type and what to look for at each step. No reading required.

Know the commands already? Run openremap commands for a one-line-per-command cheat-sheet.

Installation

See the full setup guide → docs/setup.md

Quick start for most users — openremap is on PyPI:

uv tool install openremap

Prefer plain pip?

pip install openremap

openremap is then available from any folder, no activation required. Shell completion, development setup, updating, and troubleshooting are all covered in docs/setup.md.

Commands

Every command supports --help for a quick reminder of its arguments and options.

Command	What it does	Reference
`commands`	Compact cheat-sheet — all commands at a glance	→ commands.md
`workflow`	Step-by-step guide — start here if you are new	→ workflow.md
`families`	List every supported ECU family with era, size, and notes	→ families.md
`families --family <NAME>`	Full detail for one ECU family	→ families.md
`scan`	Sort a folder of ECU files by manufacturer and family	→ scan.md
`identify`	Read an ECU binary and print everything extracted from it	→ identify.md
`cook`	Compare a stock and a tuned binary and save the difference as a recipe	→ cook.md
`tune`	One-shot: validate before → apply → validate after	→ tune.md
`validate before`	Pre-flight check — run before tuning (or use `tune`)	→ validate.md#before
`validate check`	Diagnostic — run when `validate before` fails	→ validate.md#check
`validate after`	Post-tune confirmation — run after tuning (or use `tune`)	→ validate.md#after

validate strict / validate exists / validate tuned are deprecated aliases for validate before / validate check / validate after. They still work but print a rename notice. Update your scripts when convenient.

Quick-start example

# New here? Print the full step-by-step guide first
openremap workflow

# Need a quick reminder of all commands?
openremap commands

# Not sure if your ECU is supported?
openremap families
openremap families --family EDC16

# (Optional) Sort a folder of binaries into a tidy library
openremap scan ./my_bins/                    # preview — nothing moves
openremap scan ./my_bins/ --move --organize  # sort into Bosch/EDC17/ etc.

# 1. Read the stock binary — confirm it is a supported ECU
openremap identify stock.bin

# 2. Extract the tune — diff stock vs tuned and save as a recipe
openremap cook stock.bin stage1.bin --output recipe.remap

# 3. One-shot: validate before → apply → validate after
openremap tune target.bin recipe.remap

# If tune fails at Phase 1 — diagnose why
openremap validate check target.bin recipe.remap

# 4. MANDATORY — correct checksums with ECM Titanium, WinOLS, or equivalent
#    before flashing the tuned binary to any vehicle

CLI Reference

Full reference for the openremap command-line interface. For interactive use, just run openremap with no arguments to launch the TUI.

No server, no database, no internet connection required — install and run anywhere.

New to the terminal? Run openremap workflow first. It prints a complete plain-English walkthrough with the exact commands to type and what to look for at each step. No reading required.

Know the commands already? Run openremap commands for a one-line-per-command cheat-sheet.

Installation

See the full setup guide → docs/setup.md

Quick start for most users — openremap is on PyPI:

uv tool install openremap

Prefer plain pip?

pip install openremap

openremap is then available from any folder, no activation required. Shell completion, development setup, updating, and troubleshooting are all covered in docs/setup.md.

Commands

Every command supports --help for a quick reminder of its arguments and options.

Command	What it does	Reference
`commands`	Compact cheat-sheet — all commands at a glance	→ commands.md
`workflow`	Step-by-step guide — start here if you are new	→ workflow.md
`families`	List every supported ECU family with era, size, and notes	→ families.md
`families --family <NAME>`	Full detail for one ECU family	→ families.md
`scan`	Sort a folder of ECU files by manufacturer and family	→ scan.md
`identify`	Read an ECU binary and print everything extracted from it	→ identify.md
`cook`	Compare a stock and a tuned binary and save the difference as a recipe	→ cook.md
`tune`	One-shot: validate before → apply → validate after	→ tune.md
`validate before`	Pre-flight check — run before tuning (or use `tune`)	→ validate.md#before
`validate check`	Diagnostic — run when `validate before` fails	→ validate.md#check
`validate after`	Post-tune confirmation — run after tuning (or use `tune`)	→ validate.md#after

validate strict / validate exists / validate tuned are deprecated aliases for validate before / validate check / validate after. They still work but print a rename notice. Update your scripts when convenient.

Quick-start example

# New here? Print the full step-by-step guide first
openremap workflow

# Need a quick reminder of all commands?
openremap commands

# Not sure if your ECU is supported?
openremap families
openremap families --family EDC16

# (Optional) Sort a folder of binaries into a tidy library
openremap scan ./my_bins/                    # preview — nothing moves
openremap scan ./my_bins/ --move --organize  # sort into Bosch/EDC17/ etc.

# 1. Read the stock binary — confirm it is a supported ECU
openremap identify stock.bin

# 2. Extract the tune — diff stock vs tuned and save as a recipe
openremap cook stock.bin stage1.bin --output recipe.remap

# 3. One-shot: validate before → apply → validate after
openremap tune target.bin recipe.remap

# If tune fails at Phase 1 — diagnose why
openremap validate check target.bin recipe.remap

# 4. MANDATORY — correct checksums with ECM Titanium, WinOLS, or equivalent
#    before flashing the tuned binary to any vehicle

Document	Contents
`docs/commands/`	Per-command reference — arguments, options, examples, example output
`docs/confidence.md`	Confidence scoring — tiers, signals, warnings, and score breakdown
`docs/manufacturers/bosch.md`	Supported Bosch ECU families — ident formats, file sizes, SW/HW layout
`docs/manufacturers/siemens.md`	Supported Siemens ECU families
`docs/manufacturers/delphi.md`	Supported Delphi ECU families
`docs/manufacturers/marelli.md`	Supported Magneti Marelli ECU families
`docs/about.md`	How it works — the recipe format, the match key, use cases, FAQ
`docs/recipe-format.md`	The recipe format spec (.remap) — fields, structure, versioning
`CONTRIBUTING.md`	How to add a new ECU extractor, code style, submitting a PR
`DISCLAIMER.md`	Liability, intended use, professional review requirements

Document	Contents
`docs/commands/`	Per-command reference — arguments, options, examples, example output
`docs/confidence.md`	Confidence scoring — tiers, signals, warnings, and score breakdown
`docs/manufacturers/bosch.md`	Supported Bosch ECU families — ident formats, file sizes, SW/HW layout
`docs/manufacturers/siemens.md`	Supported Siemens ECU families
`docs/manufacturers/delphi.md`	Supported Delphi ECU families
`docs/manufacturers/marelli.md`	Supported Magneti Marelli ECU families
`docs/about.md`	How it works — the recipe format, the match key, use cases, FAQ
`docs/recipe-format.md`	The recipe format spec (.remap) — fields, structure, versioning
`CONTRIBUTING.md`	How to add a new ECU extractor, code style, submitting a PR
`DISCLAIMER.md`	Liability, intended use, professional review requirements

CLI Reference

Installation

Commands

Quick-start example

Other documentation

CLI Reference

Installation

Commands

Quick-start example

Other documentation