From 47a20afd2de6303c4f7f39ec6d8aae4a1c95b3b6 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Wed, 23 Aug 2023 03:53:24 +0200 Subject: [PATCH] docs: improve correctness --- docs/1_usage.md | 45 ++++++++++--------- .../revanced/cli/command/UninstallCommand.kt | 2 +- 2 files changed, 26 insertions(+), 21 deletions(-) diff --git a/docs/1_usage.md b/docs/1_usage.md index 2bde6de..27bd3d8 100644 --- a/docs/1_usage.md +++ b/docs/1_usage.md @@ -10,13 +10,14 @@ Learn how to ReVanced CLI. adb shell exit ``` - If you want to install 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. + Optionally, you can install the patched APK file on your device by mounting it on top of the original APK file. + You will need root permissions for this. Check if you have root permissions by running the following command: ```bash adb shell su -c exit ``` -2. Get the name of your device +2. Get your device serial ```bash adb devices @@ -37,22 +38,23 @@ Learn how to ReVanced CLI. --with-packages \ --with-versions \ --with-options \ - revanced-patches.jar + revanced-patches.jar [ ...] ``` - ### ⚙️ Generate options from patches using ReVanced CLI - Some patches accept options. + This will generate an `options.json` file for the patches from a list of supplied patch bundles. + The file can be supplied to ReVanced CLI later on. - ```bash java -jar revanced-cli.jar options \ + --path options.json \ --overwrite \ - --update \ - revanced-patches.jar + revanced-patches.jar [ ...] ``` > **Note**: A default `options.json` file will be automatically generated, if it does not exist - without any need of intervention. + without any need of intervention when using the `patch` command. ```bash @@ -62,10 +64,10 @@ Learn how to ReVanced CLI. ```bash java -jar revanced-cli.jar patch \ - -b revanced-patches.jar \ - -o patched-output.apk \ - -d device-serial \ - input-apk + --patch-bundle revanced-patches.jar \ + --out output.apk \ + --device-serial \ + input.apk ``` - ### 👾 Use ReVanced CLI to patch an APK file but install with root permissions @@ -75,20 +77,23 @@ Learn how to ReVanced CLI. ```bash adb install input.apk java -jar revanced-cli.jar patch \ - -o patched-output.apk \ - -b revanced-patches.jar \ - -e some-patch \ - -d device-serial \ + --patch-bundle revanced-patches.jar \ + --include some-other-patch \ + --exclude some-patch \ + --out patched-output.apk \ + --device-serial \ --mount \ - input-apk + input.apk ``` - > **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. - package + > **Note**: Some patches may require integrations + such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations). + Supply them with the option `-m`. If any patches accepted by ReVanced Patcher require ReVanced Integrations, + they will be merged into the APK file automatically. - ### 🗑️ Uninstall a patched ```bash java -jar revanced-cli.jar uninstall \ - -p package-name \ - device-serial + --package-name \ + ``` diff --git a/src/main/kotlin/app/revanced/cli/command/UninstallCommand.kt b/src/main/kotlin/app/revanced/cli/command/UninstallCommand.kt index 27916de..84e673a 100644 --- a/src/main/kotlin/app/revanced/cli/command/UninstallCommand.kt +++ b/src/main/kotlin/app/revanced/cli/command/UninstallCommand.kt @@ -7,7 +7,7 @@ import picocli.CommandLine.Help.Visibility.ALWAYS @Command( name = "uninstall", - description = ["Uninstall a patched package from the devices with the supplied ADB device serials"] + description = ["Uninstall a patched APK file from the devices with the supplied ADB device serials"] ) internal object UninstallCommand : Runnable { @Parameters(