openandroidinstaller-dev/openandroidinstaller

Makes installing alternative Android distributions nice and easy.

Python

527

946 commits

updated Sep 7, 2026

See the code

README

[!WARNING] This application is currently not actively maintained! Everything is provided as is, don't expect bugfixes or new features (for now)

OpenAndroidInstaller

OpenAndroidInstaller

Makes installing alternative Android distributions nice and easy!

License Release Downloads Flathub Twitter Mastodon

The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like LineageOS.

Website · Report Bugs

[!WARNING] This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.

[!IMPORTANT] Unlocking the bootloader will erase all data on your device! This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected. Depending on your device you might be able to back up the TA partition using exploits and gaining temporary root access. On Sony Xperia 1/5 series phones DRM L1 will return once the bootloader is relocked. Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.

Usage

Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and macOS are also supported, but you might experience more issues.

1. Download OpenAndroidInstaller

[!WARNING] ARM-based systems are not supported.

OpenAndroidInstaller support all three major operating systems, namely Linux, macOS and Windows. You can download the correct version for you system from the GitHub Releases.

The executables are compressed inside .zip files, so you'll have to extract them first (make sure you have extracting software installed). If you get prompted to, you'll have to adjust the permission of the executable to ensure its proper functionality.

If you run Windows, you might also need to install the Universal USB Drivers and other potentially drivers needed for your device.

For Linux, a Flatpak version is available in Flathub, org.openandroidinstaller.OpenAndroidInstaller.

2. Download the custom ROM, recovery image & optional add-ons

Here are the official links for:

3. Start OpenAndroidInstaller

After starting the app you will be prompted to plug your device into your computer and you will be given a step-by-step tutorial on how to install your new OS for your specific device.

Officially supported devices

Currently, the we support 88 devices by various vendors and working on adding more soon!

Support for these devices is provided as best effort, but things might still go wrong. Help to improve the tool by reporting any issues you might face.

Fairphone
VendorDevice NameCodeNameModelsStatus
FairphoneFairphone 2FP2tested
FairphoneFairphone 3FP3tested
FairphoneFairphone 4FP4tested
Google
VendorDevice NameCodeNameModelsStatus
GooglePixel 2walleyewalleyetested
GooglePixel 2 XLtaimentaimentested
GooglePixel 3bluelinebluelinetested
GooglePixel 3 XLcrosshatchcrosshatchtested
GooglePixel 3asargosargotested
GooglePixel 3a XLbonitobonitotested
GooglePixel 4flameflametested
GooglePixel 4 XLcoralcoraltested
GooglePixel 4asunfishsunfishtested
GooglePixel 5redfinredfintested
GooglePixel 5abarbetbarbettested
Motorola
VendorDevice NameCodeNameModelsStatus
MotorolaedgeracerXT2063-2, XT2063-3tested
Motorolamoto g5cedricXT1670, XT1671, XT1672, XT1675, XT1676, XT1677tested
Motorolamoto g5smontanaXT1790, XT1791, XT1792, XT1793, XT1794, XT1795, XT1797, XT1799-2untested
Motorolamoto g5 pluspotterXT1680, XT1681, XT1683, XT1684, XT1685, XT1686, XT1687untested
Motorolamoto g6aliXT1925-1, XT1925-3, XT1925-4, XT1925-5, XT1925-6, XT1925-7, XT1925-13tested
Motorolamoto g6 plusevertXT1926-2, XT1926-3, XT1926-5, XT1926-6, XT1926-7, XT1926-8, XT1926-9tested
Motorolamoto g7 poweroceanXT1955-1, XT1955-2, XT1955-4, XT1955-5, XT1955-7tested
Motorolamoto g 5G plus / one 5GnairoXT2075-3, XT2075-5tested
Motorolamoto g 5G / one 5G acekievXT2113-2, XT2113-3tested
Motorolamoto zgriffinXT1650-3, XT1650-05tested
Motorolamoto z playaddisonXT1635-01, XT1635-02, XT1635-03untested
OnePlus
VendorDevice NameCodeNameModelsStatus
OnePlusOnebaconA0001tested
OnePlus3/3Toneplus3A3000, A3003, A3010untested
OnePlus5cheeseburgerA5000tested
OnePlus5TdumplingA5010tested
OnePlus6enchiladaA6000, A6003tested
OnePlus6TfajitaA6010, A6013tested
OnePlus7guacamolebGM1900, GM1901, GM1903, GM1905tested
OnePlus7 ProguacamoleGM1910, GM1911, GM1913, GM1917tested
OnePlus7ThotdogbHD1900, HD1901, HD1903, HD1905tested
OnePlus7T ProhotdogHD1910, HD1911, HD1913, HD1917tested
OnePlusNordaviciiAC2001, AC2003tested
OnePlusNord N10billieBE2026, BE2029untested
OnePlusNord N200dreDE2117tested
OnePlus9lemonadeLE2110, LE2111, LE2113, LE2115under development
Samsung
VendorDevice NameCodeNameModelsStatus
SamsungGalaxy J7 2015j7eltetested
SamsungGalaxy J7 Primeon7xelteuntested
SamsungGalaxy A3 2017a3y17lteSM-A320FLtested
SamsungGalaxy A5 2016a5xelteSM-A510Ftested
SamsungGalaxy A5 2017a5y17ltetested
SamsungGalaxy A7 2016a7xeltetested
SamsungGalaxy A7 2017a7y17lteuntested
SamsungGalaxy Grand Prime VEgrandprimevelteSM-G531Ftested
SamsungGalaxy S III Neos3ve3gGT-I9301Itested
SamsungGalaxy Tab S2gts210vewifiT813tested
SamsungGalaxy S4jfltexxuntested
SamsungGalaxy S4 Mini LTEserranoltexxtested
SamsungGalaxy S5klteG900F/M/R4/R7/T/V/W8tested
SamsungGalaxy S5 minikminilteSM-G800F/M/Ytested
SamsungGalaxy S6zerofltexxtested
SamsungGalaxy S6 Edgezeroltexxtested
SamsungGalaxy S7herolteSM-G930Ftested
SamsungGalaxy S7 Edgehero2ltetested
SamsungGalaxy S8dreamltetested
SamsungGalaxy S9starltetested
SamsungGalaxy Note 3 LTEhltetmoN900T/V/W8tested
SamsungGalaxy Note 8greatlteSM-N950Ftested
SamsungGalaxy Note 9crownltetested
SamsungGalaxy Note 10d1tested
SamsungGalaxy Note 10+d2stested
Sony
VendorDevice NameCodeNameModelsStatus
SonyXperia ZyugaC6603tested
SonyXperia Z3z3tested
SonyXperia 10kirintested
SonyXperia 10 Plusmermaidtested
SonyXperia XA2pioneertested
SonyXperia XZ2akaritested
SonyXperia XZ3akatsukitested
SonyXperia XZkaguraplanned
Xiaomi & Poco
VendorDevice NameCodeNameModelsStatus
XiaomiRedmi 7A / 8 / 8A / 8A DualMi439 : pine / olive / olivelite / olivewoodtested
XiaomiRedmi 9A / 9C / 9AT / 9i / 9A Sport / 10A / 10A Sportgarden / dandelion / blossom / angelicantested
XiaomiRedmi 9 / Poco M2lancelot / galahad / shivanuntested
XiaomiRedmi Note 7lavendertested
XiaomiRedmi Note 7 Proviolettested
XiaomiRedmi Note 8 / 8Tginkgo / willowuntested
XiaomiRedmi Note 8 Probegoniauntested
XiaomiRedmi Note 9S / 9 Pro / 9 Pro Max / 10 Lite / Poco M2 promiatoll : gram / curtana / excalibur / joyeuseuntested
XiaomiRedmi Note 10S / 11SE / Poco M5Srosemary / maltose / secret /rosemary_puntested
XiaomiRedmi Note 10 ProsweetM2101K6Gtested
XiaomiMi A2 / Mi 6Xjasmine_sproutuntested
XiaomiMi 8dipperuntested
XiaomiMi 9T / Redmi K20davinci / davinciinuntested
XiaomiRedmi K20 Pro / Mi 9T Proraphael / raphaelinuntested
XiaomiMi 10T / Mi 10T Pro / Redmi K20apollon / apollountested
XiaomiRedmi K40 / Mi 11X / Poco F3alioth / aliothinuntested
XiaomiPoco X3 / X3 NFCsurya / karnauntested
XiaomiPoco X3 Provayutested
Xiaomi12cupiduntested

... and more to come!

Tutorials

Contributing

All kinds of contributions are welcome. These include and are not limited to:

  • Fixing and improving texts in configs and in the application
  • Testing the tool for a supported device
  • Creating a config for a new device
  • Testing the application on your computer and/or device
  • Contributing an application build for a new platform
  • Adding features and/or improving the codebase
  • Reporting bugs

Make sure to check if your issue or PR has already been fixed or implemented before opening a new one!

More sources:

Collection of anonymous usage data

The OpenAndroidInstaller application collects anonymous usage data to help us improve the application. This data is collected using Plausible Analytics and is stored on their servers. You can see what is collected here: Statistics.

We do not collect any personal data, and we do not track individual users. We only collect the device code when the installation process is started and finished to see which devices are most commonly used with the application. The code is available in the function send_tracking_info in the openandroidinstaller/utils.py file.

Acknowledgements

The project is supported by the following organizations and companies:

  • We received financial support from the German Federal Ministry for Education and Research under the grant identifier 01IS22S26 from September 2022 until February 2023.

logos of the "Bundesministerium für Bildung und Forschung", Prodotype Fund and OKFN-Deutschland

  • The company ekimia.fr donated devices for testing and development purposes.

logo of ekimia.fr

Credits

  • The Android SDK Platform Tools (such as adb and fastboot) are Apache-licensed universal Android utilities
  • Heimdall is an MIT-licensed replacement for the leaked ODIN tool to flash Samsung devices.
  • libusb-1.0 is a LGPL-2.1-licensed library for USB device access from Linux, macOS, Windows and others.
  • copy-partitions-20220613-signed.zip The copy-partitions script was created by LineageOS developer erfanoabdi and filipepferraz and released under LGPL. (It's used when the partitions need to be copied before flashing)

License

Original development by Tobias Sterbak. Copyright (C) 2022-2025.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see gnu.org/licenses.

android
customrom
hacktoberfest
lineage-os
lineageos
lineageos-devices
linux
macos
open-source
rom
twrp
twrp-recovery
unofficial
windows

openandroidinstaller-dev/openandroidinstaller

Makes installing alternative Android distributions nice and easy.

Python

527

946 commits

updated Sep 7, 2026

See the code

README

[!WARNING] This application is currently not actively maintained! Everything is provided as is, don't expect bugfixes or new features (for now)

OpenAndroidInstaller

OpenAndroidInstaller

Makes installing alternative Android distributions nice and easy!

License Release Downloads Flathub Twitter Mastodon

The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like LineageOS.

Website · Report Bugs

[!WARNING] This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.

[!IMPORTANT] Unlocking the bootloader will erase all data on your device! This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected. Depending on your device you might be able to back up the TA partition using exploits and gaining temporary root access. On Sony Xperia 1/5 series phones DRM L1 will return once the bootloader is relocked. Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.

Usage

Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and macOS are also supported, but you might experience more issues.

1. Download OpenAndroidInstaller

[!WARNING] ARM-based systems are not supported.

OpenAndroidInstaller support all three major operating systems, namely Linux, macOS and Windows. You can download the correct version for you system from the GitHub Releases.

The executables are compressed inside .zip files, so you'll have to extract them first (make sure you have extracting software installed). If you get prompted to, you'll have to adjust the permission of the executable to ensure its proper functionality.

If you run Windows, you might also need to install the Universal USB Drivers and other potentially drivers needed for your device.

For Linux, a Flatpak version is available in Flathub, org.openandroidinstaller.OpenAndroidInstaller.

2. Download the custom ROM, recovery image & optional add-ons

Here are the official links for:

3. Start OpenAndroidInstaller

After starting the app you will be prompted to plug your device into your computer and you will be given a step-by-step tutorial on how to install your new OS for your specific device.

Officially supported devices

Currently, the we support 88 devices by various vendors and working on adding more soon!

Support for these devices is provided as best effort, but things might still go wrong. Help to improve the tool by reporting any issues you might face.

Fairphone
VendorDevice NameCodeNameModelsStatus
FairphoneFairphone 2FP2tested
FairphoneFairphone 3FP3tested
FairphoneFairphone 4FP4tested
Google
VendorDevice NameCodeNameModelsStatus
GooglePixel 2walleyewalleyetested
GooglePixel 2 XLtaimentaimentested
GooglePixel 3bluelinebluelinetested
GooglePixel 3 XLcrosshatchcrosshatchtested
GooglePixel 3asargosargotested
GooglePixel 3a XLbonitobonitotested
GooglePixel 4flameflametested
GooglePixel 4 XLcoralcoraltested
GooglePixel 4asunfishsunfishtested
GooglePixel 5redfinredfintested
GooglePixel 5abarbetbarbettested
Motorola
VendorDevice NameCodeNameModelsStatus
MotorolaedgeracerXT2063-2, XT2063-3tested
Motorolamoto g5cedricXT1670, XT1671, XT1672, XT1675, XT1676, XT1677tested
Motorolamoto g5smontanaXT1790, XT1791, XT1792, XT1793, XT1794, XT1795, XT1797, XT1799-2untested
Motorolamoto g5 pluspotterXT1680, XT1681, XT1683, XT1684, XT1685, XT1686, XT1687untested
Motorolamoto g6aliXT1925-1, XT1925-3, XT1925-4, XT1925-5, XT1925-6, XT1925-7, XT1925-13tested
Motorolamoto g6 plusevertXT1926-2, XT1926-3, XT1926-5, XT1926-6, XT1926-7, XT1926-8, XT1926-9tested
Motorolamoto g7 poweroceanXT1955-1, XT1955-2, XT1955-4, XT1955-5, XT1955-7tested
Motorolamoto g 5G plus / one 5GnairoXT2075-3, XT2075-5tested
Motorolamoto g 5G / one 5G acekievXT2113-2, XT2113-3tested
Motorolamoto zgriffinXT1650-3, XT1650-05tested
Motorolamoto z playaddisonXT1635-01, XT1635-02, XT1635-03untested
OnePlus
VendorDevice NameCodeNameModelsStatus
OnePlusOnebaconA0001tested
OnePlus3/3Toneplus3A3000, A3003, A3010untested
OnePlus5cheeseburgerA5000tested
OnePlus5TdumplingA5010tested
OnePlus6enchiladaA6000, A6003tested
OnePlus6TfajitaA6010, A6013tested
OnePlus7guacamolebGM1900, GM1901, GM1903, GM1905tested
OnePlus7 ProguacamoleGM1910, GM1911, GM1913, GM1917tested
OnePlus7ThotdogbHD1900, HD1901, HD1903, HD1905tested
OnePlus7T ProhotdogHD1910, HD1911, HD1913, HD1917tested
OnePlusNordaviciiAC2001, AC2003tested
OnePlusNord N10billieBE2026, BE2029untested
OnePlusNord N200dreDE2117tested
OnePlus9lemonadeLE2110, LE2111, LE2113, LE2115under development
Samsung
VendorDevice NameCodeNameModelsStatus
SamsungGalaxy J7 2015j7eltetested
SamsungGalaxy J7 Primeon7xelteuntested
SamsungGalaxy A3 2017a3y17lteSM-A320FLtested
SamsungGalaxy A5 2016a5xelteSM-A510Ftested
SamsungGalaxy A5 2017a5y17ltetested
SamsungGalaxy A7 2016a7xeltetested
SamsungGalaxy A7 2017a7y17lteuntested
SamsungGalaxy Grand Prime VEgrandprimevelteSM-G531Ftested
SamsungGalaxy S III Neos3ve3gGT-I9301Itested
SamsungGalaxy Tab S2gts210vewifiT813tested
SamsungGalaxy S4jfltexxuntested
SamsungGalaxy S4 Mini LTEserranoltexxtested
SamsungGalaxy S5klteG900F/M/R4/R7/T/V/W8tested
SamsungGalaxy S5 minikminilteSM-G800F/M/Ytested
SamsungGalaxy S6zerofltexxtested
SamsungGalaxy S6 Edgezeroltexxtested
SamsungGalaxy S7herolteSM-G930Ftested
SamsungGalaxy S7 Edgehero2ltetested
SamsungGalaxy S8dreamltetested
SamsungGalaxy S9starltetested
SamsungGalaxy Note 3 LTEhltetmoN900T/V/W8tested
SamsungGalaxy Note 8greatlteSM-N950Ftested
SamsungGalaxy Note 9crownltetested
SamsungGalaxy Note 10d1tested
SamsungGalaxy Note 10+d2stested
Sony
VendorDevice NameCodeNameModelsStatus
SonyXperia ZyugaC6603tested
SonyXperia Z3z3tested
SonyXperia 10kirintested
SonyXperia 10 Plusmermaidtested
SonyXperia XA2pioneertested
SonyXperia XZ2akaritested
SonyXperia XZ3akatsukitested
SonyXperia XZkaguraplanned
Xiaomi & Poco
VendorDevice NameCodeNameModelsStatus
XiaomiRedmi 7A / 8 / 8A / 8A DualMi439 : pine / olive / olivelite / olivewoodtested
XiaomiRedmi 9A / 9C / 9AT / 9i / 9A Sport / 10A / 10A Sportgarden / dandelion / blossom / angelicantested
XiaomiRedmi 9 / Poco M2lancelot / galahad / shivanuntested
XiaomiRedmi Note 7lavendertested
XiaomiRedmi Note 7 Proviolettested
XiaomiRedmi Note 8 / 8Tginkgo / willowuntested
XiaomiRedmi Note 8 Probegoniauntested
XiaomiRedmi Note 9S / 9 Pro / 9 Pro Max / 10 Lite / Poco M2 promiatoll : gram / curtana / excalibur / joyeuseuntested
XiaomiRedmi Note 10S / 11SE / Poco M5Srosemary / maltose / secret /rosemary_puntested
XiaomiRedmi Note 10 ProsweetM2101K6Gtested
XiaomiMi A2 / Mi 6Xjasmine_sproutuntested
XiaomiMi 8dipperuntested
XiaomiMi 9T / Redmi K20davinci / davinciinuntested
XiaomiRedmi K20 Pro / Mi 9T Proraphael / raphaelinuntested
XiaomiMi 10T / Mi 10T Pro / Redmi K20apollon / apollountested
XiaomiRedmi K40 / Mi 11X / Poco F3alioth / aliothinuntested
XiaomiPoco X3 / X3 NFCsurya / karnauntested
XiaomiPoco X3 Provayutested
Xiaomi12cupiduntested

... and more to come!

Tutorials

Contributing

All kinds of contributions are welcome. These include and are not limited to:

  • Fixing and improving texts in configs and in the application
  • Testing the tool for a supported device
  • Creating a config for a new device
  • Testing the application on your computer and/or device
  • Contributing an application build for a new platform
  • Adding features and/or improving the codebase
  • Reporting bugs

Make sure to check if your issue or PR has already been fixed or implemented before opening a new one!

More sources:

Collection of anonymous usage data

The OpenAndroidInstaller application collects anonymous usage data to help us improve the application. This data is collected using Plausible Analytics and is stored on their servers. You can see what is collected here: Statistics.

We do not collect any personal data, and we do not track individual users. We only collect the device code when the installation process is started and finished to see which devices are most commonly used with the application. The code is available in the function send_tracking_info in the openandroidinstaller/utils.py file.

Acknowledgements

The project is supported by the following organizations and companies:

  • We received financial support from the German Federal Ministry for Education and Research under the grant identifier 01IS22S26 from September 2022 until February 2023.

logos of the "Bundesministerium für Bildung und Forschung", Prodotype Fund and OKFN-Deutschland

  • The company ekimia.fr donated devices for testing and development purposes.

logo of ekimia.fr

Credits

  • The Android SDK Platform Tools (such as adb and fastboot) are Apache-licensed universal Android utilities
  • Heimdall is an MIT-licensed replacement for the leaked ODIN tool to flash Samsung devices.
  • libusb-1.0 is a LGPL-2.1-licensed library for USB device access from Linux, macOS, Windows and others.
  • copy-partitions-20220613-signed.zip The copy-partitions script was created by LineageOS developer erfanoabdi and filipepferraz and released under LGPL. (It's used when the partitions need to be copied before flashing)

License

Original development by Tobias Sterbak. Copyright (C) 2022-2025.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see gnu.org/licenses.

android
customrom
hacktoberfest
lineage-os
lineageos
lineageos-devices
linux
macos
open-source
rom
twrp
twrp-recovery
unofficial
windows

Significant stargazers

Vlad Filippov

1,961 followers · starred Dec 2022

Madis Otenurm

71 followers · starred Feb 2023

cketti

649 followers · starred Jan 2023

JakobDev

32 followers · starred Jan 2023