ReVanced-Mirror/revanced-cli
1
0
Fork 0
mirror of https://github.com/revanced/revanced-cli.git synced 2024-11-19 10:09:22 +01:00
Code Issues Projects Releases Wiki Activity
4c9d414228
revanced-cli/docs/1_usage.md
oSumAtrIX f6c221d72d
feat: use new patch naming convention
2023-07-11 05:06:46 +02:00

2.3 KiB
Raw Blame History

🛠️ Using ReVanced CLI

Learn how to ReVanced CLI.

⚡ Setup ADB

  1. Ensure that ADB is working

    adb shell exit

    If you want to deploy the patched APK file on your device by mounting it on top of the original APK file, you will need root access. This is optional.

    adb shell su -c exit

  2. Get the name of your device

    adb devices

🔨 Using ReVanced CLI

  • ⚙️ Show all available options for ReVanced CLI

    java -jar revanced-cli.jar -h

  • 📃 List all available patches from supplied patch bundles

    java -jar revanced-cli.jar
 -b revanced-patches.jar \
 -l # Names of all patches will be in kebab-case

  • 💉 Use ReVanced CLI to patch an APK file but deploy without root permissions

    This will deploy the patched APK file on your device by installing it.

    java -jar revanced-cli.jar \
 -a input.apk \
 -o patched-output.apk \
 -b revanced-patches.jar \
 -d device-name

  • 👾 Use ReVanced CLI to patch an APK file but deploy with root permissions

    This will deploy the patched APK file on your device by mounting it on top of the original APK file.

    adb install input.apk
java -jar revanced-cli.jar \
 -a input.apk \
 -o patched-output.apk \
 -b revanced-patches.jar \
 -e vanced-microg-support \
 -d device-name \
 --mount

    Note

    : Some patches from ReVanced Patches also require ReVanced Integrations. Supply them with the option -m. ReVanced Patcher will merge ReVanced Integrations automatically, depending on if the supplied patches require them.

  • ⚙️ Supply options to patches using ReVanced CLI

    Some patches provide options. Currently, ReVanced CLI will generate and consume an options.json file at the location that is specified in -o. If the option is not specified, the options file will be generated in the current working directory.

    The options file contains all options from supplied patch bundles.

    Note

    : The options.json file will be generated at the first time you use ReVanced CLI to patch an APK file for now. This will be changed in the future.