-
-
Notifications
You must be signed in to change notification settings - Fork 2
CLI Reference
openrom-core is the headless CLI included in every OpenROM release. The GUI uses it internally — but you can use it directly for scripting and automation.
# Detect file format and platform
openrom-core --detect "game.iso"
JSON output (for scripting)
openrom-core --json --detect "game.iso"
# Convert single file
openrom-core --input "game.iso" --format CHD
Convert with compression level
openrom-core --input "game.iso" --format CHD --compression Max
Convert and verify
openrom-core --input "game.iso" --format CHD --verify
Verify CHD only (no conversion)
openrom-core --input "game.chd" --verify-only
Force platform (for modded/patched ISOs)
openrom-core --input "modded.iso" --format CHD --force-platform PS2
Batch convert folder
openrom-core --folder /roms/ --format CHD
Batch with compression
openrom-core --folder /roms/ --format CHD --compression Max
# Apply patch (auto-detects format)
openrom-core --patch "game.sfc" --patch-file "hack.ips"
Force apply even if checksum mismatches
openrom-core --patch "game.sfc" --patch-file "hack.bps" --ignore-checksum
# Compress to 7Z
openrom-core --compress "game.iso" --format 7z --level ultra
Compress to ZIP
openrom-core --compress "game.iso" --format zip --level normal
Compress folder
openrom-core --compress-folder /roms/ --format 7z
Extract archive
openrom-core --extract "game.zip"
openrom-core --extract "game.7z" --output /roms/extracted/
# Remove copier header (auto-detects type)
openrom-core --remove-header "game.smc"
Specify output file
openrom-core --remove-header "game.smc" --output "game_clean.sfc"
# Generate M3U for multi-disc game folder
openrom-core --m3u "/roms/Metal Gear Solid/"
List all supported formats
openrom-core --list-formats
Show version
openrom-core --version
Help
openrom-core --help
| Flag | Description |
|---|---|
| --input | Input file path |
| --output | Output file path (optional) |
| --folder | Batch input folder |
| --format | Target format (CHD, CSO, RVZ, ZIP, 7Z…) |
| --compression | Fast / Normal / Max |
| --verify | Verify after conversion |
| --verify-only | Verify CHD without converting |
| --force-platform | Override platform detection |
| --patch | ROM file to patch |
| --patch-file | Patch file (.ips, .bps, .xdelta…) |
| --ignore-checksum | Force-apply patch |
| --compress | File to compress |
| --compress-folder | Folder to compress |
| --level | Compression level (fast/normal/ultra) |
| --extract | Archive to extract |
| --remove-header | ROM to strip header from |
| --m3u | Folder to generate M3U for |
| --detect | Detect file format and platform |
| --list-formats | List all supported formats |
| --json | Output as JSON |
| --version | Show version |
| --help | Show help |