ReVanced-Mirror/revanced-cli
1
0
Fork 0
mirror of https://github.com/revanced/revanced-cli.git synced 2024-12-11 20:57:49 +01:00
Code Issues Projects Releases Wiki Activity

docs: add section for patch options

Browse Source
This commit is contained in:
oSumAtrIX 2023-06-30 19:40:52 +02:00
parent 26112a4fd2
commit 542580ecff
No known key found for this signature in database
GPG Key ID: A9B3094ACDB604B4
2 changed files with 36 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/0_prerequisites.md
View File

@ -4,9 +4,9 @@ To use ReVanced CLI, you will need to fulfill certain requirements.
## 🤝 Requirements ## 🤝 Requirements
- Java SDK 11 (Azul JDK or OpenJDK)
- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to deploy the patched APK file on your device - [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to deploy the patched APK file on your device
- An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7) - An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7)
- Java SDK 17 or higher (Azul JDK or OpenJDK)
## ⏭️ Whats next ## ⏭️ Whats next

66
docs/1_usage.md
View File

@ -2,73 +2,75 @@
Learn how to ReVanced CLI. Learn how to ReVanced CLI.
## ⚡ Setup (optional) ## ⚡ Setup ADB
1. Make sure your device is connected 1. Ensure that ADB is working
```bash ```bash
adb shell exit adb shell exit
``` ```
If you plan to use the root variant, check if you have root access 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.
```bash ```bash
adb shell su -c exit adb shell su -c exit
``` ```
2. Copy the ADB device name 2. Get the name of your device
```bash ```bash
adb devices adb devices
``` ```
## 🔨 ReVanced CLI Usage ## 🔨 Using ReVanced CLI
- ### Show all available options for ReVanced CLI - ### ⚙️ Show all available options for ReVanced CLI
```bash ```bash
java -jar revanced-cli.jar -h java -jar revanced-cli.jar -h
``` ```
- ### List all available patches from supplied patch bundles - ### 📃 List all available patches from supplied patch bundles
```bash ```bash
java -jar revanced-cli.jar \ java -jar revanced-cli.jar
-b revanced-patches.jar \ -b revanced-patches.jar \
-l -l
``` ```
- ### Use ReVanced CLI without root permissions - ### 💉 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.
```bash ```bash
java -jar revanced-cli.jar \ java -jar revanced-cli.jar \
-a input.apk \ -a input.apk \
-o patched-output.apk \ -o patched-output.apk \
-b revanced-patches.jar -b revanced-patches.jar \
-d device-name
``` ```
- ### Mount the patched application with root permissions over the installed application - ### 👾 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.
```bash ```bash
adb install input.apk # make sure the same version is installed adb install input.apk
java -jar revanced-cli.jar \ java -jar revanced-cli.jar \
-a input.apk \ -a input.apk \
-d device-name \ -o patched-output.apk \
-o patched-output.apk \ -b revanced-patches.jar \
-b revanced-patches.jar \ -e vanced-microg-support \
-e vanced-microg-support \ -d device-name \
--mount --mount
``` ```
> **Note**: > **Note**: Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also require [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. ReVanced Patcher will merge ReVanced Integrations automatically, depending on if the supplied patches require them.
>
> - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you can exclude - ### ⚙️ Supply options to patches using ReVanced CLI
the `vanced-microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
option `-e vanced-microg-support` when mounting for example. 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.
>
> - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require The options file contains all options from supplied patch bundles.
[ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`.
> The integrations will be merged, if necessary automatically, if supplied. > **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.
>
> - If you supplied a device with the option `-d`, the patched application will be automatically installed on the
device.