Back to the overviewInstall LineageOS on
marlin
Installing Lineage Recovery using
Install LineageOS on
Google Pixel XL
marlin
Warning: The provided instructions are for LineageOS 21. These will only work if you follow every section and step precisely.
Do not continue after something fails!
Do not continue after something fails!
Basic requirements
- Read through the instructions at least once before actually following them, so as to avoid any problems due to any missed steps!
- Make sure your computer has
adb
andfastboot
. Setup instructions can be found here. - Enable USB debugging on your device.
- Boot your device with the stock OS at least once and check every functionality.
Warning: Make sure that you can send and receive SMS and place and receive calls (also via WiFi and LTE, if available), otherwise it won’t work on LineageOS either! Additionally, some devices require that VoLTE/VoWiFi be utilized once on stock to provision IMS.
- LineageOS is provided as-is with no warranty. While we attempt to verify everything works you are installing this at your own risk!
Unlocking the bootloader
Note: The steps below only need to be run once per device.
Warning: Unlocking the bootloader will erase all data on your device!
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.
- Enable OEM unlock in the Developer options under device Settings, if present.
- Connect the device to your PC via USB.
- On the computer, open a command prompt (on Windows) or terminal (on Linux or macOS) window, and type:
adb -d reboot bootloader
You can also boot into fastboot mode via a key combination:
- With the device powered off, hold Volume Down + Power.
- Once the device is in fastboot mode, verify your PC finds it by typing:
fastboot devices
If you don’t get any output or an error:
- on Windows: make sure the device appears in the device manager without a triangle. Try other drivers until the command above works!
- on Linux or macOS: If you see
no permissions fastboot
try runningfastboot
as root. When the output is empty, check your USB cable and port!
- Now type the following command to unlock the bootloader:
fastboot flashing unlock
Note: At this point, the device may display on-screen prompts which will require interaction to continue the process of unlocking the bootloader. Please take whatever actions the device asks you to in order to proceed. - If the device doesn’t automatically reboot, reboot it. It should now be unlocked.
- Since the device resets completely, you will need to re-enable USB debugging to continue.
Installing Lineage Recovery using fastboot
- Download Lineage Recovery. Simply download the latest recovery file, named
boot.img
.Important: Other recoveries may not work for installation or updates. We strongly recommend to use the one linked above! - Connect your device to your PC via USB if it isn’t already.
- If your device isn’t already in fastboot mode, on the computer, open a command prompt (on Windows) or terminal (on Linux or macOS) window, and type:
adb -d reboot bootloader
You can also boot into fastboot mode via a key combination:
- With the device powered off, hold Volume Down + Power.
- Once the device is in fastboot mode, verify your PC finds it by typing:
fastboot devices
If you don’t get any output or an error:
- on Windows: make sure the device appears in the device manager without a triangle. Try other drivers until the command above works!
- on Linux or macOS: If you see
no permissions fastboot
try runningfastboot
as root. When the output is empty, check your USB cable (preferably use a USB Type-A 2.0 one or a USB hub) and port!
Tip: Some devices have buggy USB support while in bootloader mode, if you seefastboot
hanging with no output when using commands such asfastboot getvar ...
,fastboot boot ...
,fastboot flash ...
you may want to try a different USB port (preferably a USB Type-A 2.0 one) or a USB hub. - Flash recovery onto your device:
fastboot flash boot boot.img
- Now reboot into recovery to verify the installation.
- Use the menu to navigate to and to select the
Recovery
option.
Note: If your recovery does not show the LineageOS logo , you accidentally booted into the wrong recovery. Please start at the top of this section! - Use the menu to navigate to and to select the
EFS/Persist Backup
Warning: The “EFS/Persist Backup” and “Repartition” steps only need to be run once, if you ran the repartition script during the installation guide, you do not need to do it again. If you are uncertain if you have ran it before, running it again is harmless.
Warning: Before processing repartition further we highly recommend you backup persist and EFS using adb or you might lose your IMEI/WIFI + BT mac addresses
- If you are not in recovery, reboot into recovery:
- With the device powered off, hold Volume Down + Power. Then use the menu to select Recovery Mode.
- Now, use the volume buttons to select “Advanced”, and then “Enable ADB”.
- Now open Terminal (Linux/macOS), or PowerShell (Windows), run
adb -d shell
, and then run the following commands within it:dd if=/dev/block/sdd9 of=/tmp/modemst1.img
dd if=/dev/block/sdd10 of=/tmp/modemst2.img
dd if=/dev/block/sdd3 of=/tmp/persist.img
exit
- Now from that same Terminal/PowerShell, run:
adb -d pull /tmp/modemst1.img
adb -d pull /tmp/modemst2.img
adb -d pull /tmp/persist.img
Note: Make sure to store these somewhere safe in case later steps fail.
Repartition
Warning: This step is not optional, the device will not boot LineageOS without repartitioning first!
Warning: This process will wipe all data on the device, including your internal storage!
- Download the flashable repartition script from here for 32 GB models, and here for 128 GB models.
- Rename the downloaded zip file to
repartition.zip
. - On your device’s screen, choose “Apply Update”, then “From ADB”.
- From your Terminal/PowerShell, run
adb -d sideload /path/to/repartition.zip
, filling/path/to/
in with the path you downloaded the repartition zip to.Note: The repartition script package in question isn’t signed with LineageOS’s official key, and therefore when it is sideloaded, Lineage Recovery will present a screen that saysSignature verification failed
, this is expected, please clickYes
.Warning: This step may take up to 5 minutes, please ensure your USB connection/power source isn’t interrupted during this time. - The device will complete the repartition process, and will display
Done!
on-screen, at this point please select “Advanced” then “Reboot to Recovery”, then proceed with the installation process.
Installing LineageOS from recovery
- Download the LineageOS zip file that you would like to install or build the package yourself.
- If you are not in recovery, reboot into recovery:
- With the device powered off, hold Volume Down + Power. Then use the menu to select Recovery Mode.
- Now tap Factory Reset, then Format data / factory reset and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage, as well as format your cache partition (if you have one).
- Return to the main menu.
- Sideload the LineageOS
.zip
package but do not reboot before you read/followed the rest of the instructions!- On the device, select “Apply Update”, then “Apply from ADB” to begin sideload.
- On the host machine, sideload the package using:
adb -d sideload filename.zip
.Tip: After the package is installed, recovery will inform you that reboot to recovery is required to install add-ons. In case you want to do that, please select “Yes,” otherwise “No”.Tip: Normally, adb will reportTotal xfer: 1.00x
, but in some cases, even if the process succeeds the output will stop at 47% and reportadb: failed to read command: Success
. In some cases it will reportadb: failed to read command: No error
oradb: failed to read command: Undefined error: 0
which is also fine.
Installing Add-Ons
Note: If you don’t want to install any add-on (such as Google Apps), you can skip this whole section!
Warning:
If you want to install Google Apps add-on package (use the
arm64
architecture), you can download it from here.
This add-on needs to be installed before booting into LineageOS for the first time!- Click
Apply Update
, thenApply from ADB
, thenadb -d sideload filename.zip
for all desired packages in sequence.
When presented with a screen that saysSignature verification failed
, clickYes
. It is expected as add-ons aren’t signed with LineageOS’s official key!
All set!
Once you have installed everything successfully, you can now reboot your device into the OS for the first time!
- Click the back arrow in the top left of the screen, then “Reboot system now”.
Note:
The first boot usually takes no longer than 15 minutes, depending on the device.
If it takes longer, you may have missed a step, otherwise feel free to get assistance.
Get assistance
After you’ve double checked that you followed the steps precisely, didn’t skip any and still have questions or got stuck, feel free to ask on our subreddit or in #LineageOS on Libera.Chat.