{"id":34112931,"url":"https://github.com/xiaomifirmwareupdater/xiaomi-flashable-firmware-creator","last_synced_at":"2026-04-08T12:02:15.981Z","repository":{"id":32119193,"uuid":"123586784","full_name":"XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator","owner":"XiaomiFirmwareUpdater","description":"Xiaomi Flashable Firmware Creator","archived":false,"fork":false,"pushed_at":"2026-04-04T05:11:56.000Z","size":1816,"stargazers_count":158,"open_issues_count":4,"forks_count":45,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-04-04T07:12:28.751Z","etag":null,"topics":["firmware","miui","xiaomi","xiaomi-flashable-firmware","xiaomi-flashable-firmware-creator"],"latest_commit_sha":null,"homepage":"https://xiaomifirmwareupdater.com/projects/xiaomi-flashable-firmware-creator/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"ardadem/xiaomi-flashable-firmware-creator","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/XiaomiFirmwareUpdater.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"yshalsager","patreon":"XiaomiFirmwareUpdater","liberapay":"yshalsager","custom":["https://paypal.me/yshalsager"]}},"created_at":"2018-03-02T14:08:38.000Z","updated_at":"2026-04-04T05:11:24.000Z","dependencies_parsed_at":"2026-01-24T08:12:39.599Z","dependency_job_id":null,"html_url":"https://github.com/XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator","commit_stats":{"total_commits":189,"total_committers":7,"mean_commits":27.0,"dds":0.328042328042328,"last_synced_commit":"85b8a72b83d80ea4f0a7e9e72bf99164c22ff6d7"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiaomiFirmwareUpdater%2Fxiaomi-flashable-firmware-creator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiaomiFirmwareUpdater%2Fxiaomi-flashable-firmware-creator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiaomiFirmwareUpdater%2Fxiaomi-flashable-firmware-creator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiaomiFirmwareUpdater%2Fxiaomi-flashable-firmware-creator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XiaomiFirmwareUpdater","download_url":"https://codeload.github.com/XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiaomiFirmwareUpdater%2Fxiaomi-flashable-firmware-creator/sbom","scorecard":{"id":153330,"data":{"date":"2025-08-11","repo":{"name":"github.com/XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator","commit":"f5a13fcace49547f324067d80a72aa33a7d1fcb7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Maintained","score":10,"reason":"25 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/16 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: xiaomi_flashable_firmware_creator/binaries/update-binary:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T11:12:26.937Z","repository_id":32119193,"created_at":"2025-08-16T11:12:26.938Z","updated_at":"2025-08-16T11:12:26.938Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31554110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T10:21:54.569Z","status":"ssl_error","status_checked_at":"2026-04-08T10:21:38.171Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["firmware","miui","xiaomi","xiaomi-flashable-firmware","xiaomi-flashable-firmware-creator"],"created_at":"2025-12-14T19:05:20.098Z","updated_at":"2026-04-08T12:02:15.954Z","avatar_url":"https://github.com/XiaomiFirmwareUpdater.png","language":"Python","funding_links":["https://github.com/sponsors/yshalsager","https://patreon.com/XiaomiFirmwareUpdater","https://liberapay.com/yshalsager","https://paypal.me/yshalsager","https://www.paypal.me/yshalsager"],"categories":[],"sub_categories":[],"readme":"## Xiaomi Flashable Firmware Creator\n\nCreate flashable firmware zip from MIUI and HyperOS Recovery ROMs!\n\n[![PyPI version](https://badge.fury.io/py/xiaomi-flashable-firmware-creator.svg)](https://pypi.org/project/xiaomi-flashable-firmware-creator/)\n[![made-with-python](https://img.shields.io/badge/Made%20with-Python%203-3776AB?style=flat\\\u0026labelColor=3776AB\\\u0026logo=python\\\u0026logoColor=white\\\u0026link=https://www.python.org/)](https://www.python.org/)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c1f6cee01b74ef8a2fd0f0c787596a8)](https://www.codacy.com/gh/XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator/dashboard?utm_source=github.com\\\u0026utm_medium=referral\\\u0026utm_content=XiaomiFirmwareUpdater/xiaomi-flashable-firmware-creator\\\u0026utm_campaign=Badge_Grade)\n[![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.svg?v=103)](#) \u003cbr /\u003e\n[![PayPal](https://img.shields.io/badge/PayPal-Donate-00457C?style=flat\\\u0026labelColor=00457C\\\u0026logo=PayPal\\\u0026logoColor=white\\\u0026link=https://www.paypal.me/yshalsager)](https://www.paypal.me/yshalsager)\n[![Patreon](https://img.shields.io/badge/Patreon-Support-F96854?style=flat\\\u0026labelColor=F96854\\\u0026logo=Patreon\\\u0026logoColor=white\\\u0026link=https://www.paypal.me/yshalsager)](https://www.paypal.me/yshalsager)\n[![Liberapay](https://img.shields.io/badge/Liberapay-Support-F6C915?style=flat\\\u0026labelColor=F6C915\\\u0026logo=Liberapay\\\u0026logoColor=white\\\u0026link=https://liberapay.com/yshalsager)](https://liberapay.com/yshalsager)\n\nXiaomi Flashable Firmware Creator is a tool that generates flashable firmware-update packages from official MIUI and HyperOS ROMS.\n\nIt supports creating untouched firmware, non-arb firmware, firmware + vendor flashable zip, and firmware-less ROMs from any local zip file or direct link of the zip file.\n\n### Requirements\n\nThis tool requires the following dependencies to be installed on your system:\n\n- **[payload-dumper-go](https://github.com/ssut/payload-dumper-go)**: Used for extracting Android OTA payload files. Install using your system package manager or from releases.\n- **[xz](https://tukaani.org/xz/)**: Required for payload decompression.\n\n#### Installing xz\n\n**Linux and macOS (From package manager, recommended)**:\n\n- **Ubuntu/Debian**: `sudo apt install xz-utils`\n- **CentOS/RHEL/Fedora**: `sudo yum install xz` or `sudo dnf install xz`\n- **Arch Linux**: `sudo pacman -S xz`\n- **openSUSE**: `sudo zypper install xz`\n- **macOS (Homebrew)**: `brew install xz`\n- **macOS (MacPorts)**: `sudo port install xz`\n\n**Windows**:\n\n1. Download the latest XZ Utils for Windows from [tukaani.org/xz/](https://tukaani.org/xz/)\n2. Extract the downloaded archive to a directory on your system\n3. Add the directory containing `xz.exe` to your system's PATH environment variable\n\n**Verify installation**: Run `xz --version` in your terminal to confirm xz is properly installed.\n\n**Note**: Working on a SSD is highly recommended for performance reasons when processing large payload files, as HDDs can be a bottleneck.\n\n### Installation\n\nYou can simply install this tool using [uv](https://docs.astral.sh/uv/).\n\n```shell script\nuv install xiaomi_flashable_firmware_creator\n```\n\n### CLI Usage\n\n```shell script\nxiaomi_flashable_firmware_creator [-h] (-F FIRMWARE | -N NONARB | -L FIRMWARELESS | -V VENDOR) [-o OUTPUT]\n```\n\n**Examples:**\n\n*   Creating normal (untouched) firmware:\n\n```shell script\nxiaomi_flashable_firmware_creator -F [ROM ZIP]\n```\n\n*   Creating non-arb firmware (without anti-rollback):\n\n```shell script\nxiaomi_flashable_firmware_creator -N [ROM ZIP]\n```\n\n*   Creating firmware-less ROM (stock untouched ROM with just firmware removed):\n\n```shell script\nxiaomi_flashable_firmware_creator -L [ROM ZIP]\n```\n\n*   Creating firmware + vendor flashable zip:\n\n```shell script\nxiaomi_flashable_firmware_creator -V [ROM ZIP]\n```\n\n### Using from other Python scripts\n\n```python\nfrom xiaomi_flashable_firmware_creator.firmware_creator import FlashableFirmwareCreator\n\n# initialize firmware creator object with the following parameters:\n# input_file: zip file to extract from. It can be a local path or a remote direct url.\n# process: Which mode should the tool use. This must be one of \"firmware\", \"nonarb\", \"firmwareless\" or \"vendor\". (See CLI Usage for more details)\n# out_dir: The output directory to store the extracted file in.\n\nfirmware_creator = FlashableFirmwareCreator(input_zip, process, output_dir)\n# Now, you can either use auto() method to create the new zip file or do stuff at your own using firmware_creator public methods.\nnew_zip = firmware_creator.auto()\n```\n\n## Development\n\nThis project uses several tools to streamline the development process:\n\n### mise\n\n[mise](https://mise.jdx.dev/) is used for managing project-level dependencies and environment variables. mise helps ensure consistent development environments across different machines.\n\nTo get started with mise:\n\n1. Install mise by following the instructions on the [official website](https://mise.jdx.dev/).\n2. Run `mise install` in the project root to set up the development environment.\n\nThis file is automatically loaded by mise and allows you to customize your local development environment without modifying the shared configuration files.\n\n### UV\n\n[UV](https://docs.astral.sh/uv/) is used for dependency management and packaging. It provides a clean, version-controlled way to manage project dependencies.\n\nTo set up the project with UV:\n\n1. Install UV using mise, or by following the instructions on the [official website](https://docs.astral.sh/uv/getting-started/installation/).\n2. Run `uv sync` to install project dependencies.\n\n### Development Tools\n\nFor development, this project uses additional tools managed by mise:\n\n- **[payload-dumper-go](https://github.com/ssut/payload-dumper-go)**: Automatically managed by mise when you run `mise install`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxiaomifirmwareupdater%2Fxiaomi-flashable-firmware-creator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxiaomifirmwareupdater%2Fxiaomi-flashable-firmware-creator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxiaomifirmwareupdater%2Fxiaomi-flashable-firmware-creator/lists"}