chore(release): 4.0.3-dev.1 [skip ci]

## [4.0.3-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.0.2...v4.0.3-dev.1) (2023-10-23)

.github/workflows/pull_request.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Open pull request
         uses: repo-sync/pull-request@v2
         with:

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           # Make sure the release step uses its own credentials:
           # https://github.com/cycjimmy/semantic-release-action#private-packages

CHANGELOG.md

@@ -1,3 +1,115 @@
+## [4.0.3-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.0.2...v4.0.3-dev.1) (2023-10-23)
+
+## [4.0.2](https://github.com/ReVanced/revanced-cli/compare/v4.0.1...v4.0.2) (2023-10-12)
+
+
+### Bug Fixes
+
+* Move file to output even when mounting ([59dfc98](https://github.com/ReVanced/revanced-cli/commit/59dfc988e351374eb718923d19bd9bdd94e8d3c0))
+* Use punctuation in option descriptions ([da4469f](https://github.com/ReVanced/revanced-cli/commit/da4469f402c26ad95898404236b0acf0202907e2))
+
+
+### Performance Improvements
+
+* Use multiple threads for writing dex files ([28648a1](https://github.com/ReVanced/revanced-cli/commit/28648a1c53520eef8c799504ff61a35947f878b8))
+
+## [4.0.2-dev.3](https://github.com/ReVanced/revanced-cli/compare/v4.0.2-dev.2...v4.0.2-dev.3) (2023-10-10)
+
+
+### Bug Fixes
+
+* Move file to output even when mounting ([59dfc98](https://github.com/ReVanced/revanced-cli/commit/59dfc988e351374eb718923d19bd9bdd94e8d3c0))
+
+## [4.0.2-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.0.2-dev.1...v4.0.2-dev.2) (2023-10-10)
+
+
+### Performance Improvements
+
+* Use multiple threads for writing dex files ([28648a1](https://github.com/ReVanced/revanced-cli/commit/28648a1c53520eef8c799504ff61a35947f878b8))
+
+## [4.0.2-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.0.1...v4.0.2-dev.1) (2023-10-08)
+
+
+### Bug Fixes
+
+* Use punctuation in option descriptions ([da4469f](https://github.com/ReVanced/revanced-cli/commit/da4469f402c26ad95898404236b0acf0202907e2))
+
+## [4.0.1](https://github.com/ReVanced/revanced-cli/compare/v4.0.0...v4.0.1) (2023-10-08)
+
+
+### Bug Fixes
+
+* Correct warning message ([ba573f7](https://github.com/ReVanced/revanced-cli/commit/ba573f73d0e310fdeb8be2831fd40a7188473fff))
+
+## [4.0.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.0.0...v4.0.1-dev.1) (2023-10-07)
+
+
+### Bug Fixes
+
+* Correct warning message ([e4e339d](https://github.com/ReVanced/revanced-cli/commit/e4e339dff40542d6265de59496545c859312cf11))
+
+# [4.0.0](https://github.com/ReVanced/revanced-cli/compare/v3.1.1...v4.0.0) (2023-10-04)
+
+
+### Bug Fixes
+
+* Check, if mounting is possible ([3e13fb5](https://github.com/ReVanced/revanced-cli/commit/3e13fb5d56eb2a90c2a4a1ddfc05852b1f70add5))
+* Delete temporal files if it exists ([a022feb](https://github.com/ReVanced/revanced-cli/commit/a022febd0c70807ddc3fa9948207a2a70d5191da))
+* Do not sign if mounting ([578e16b](https://github.com/ReVanced/revanced-cli/commit/578e16b099fddfd2bb56accb225d04dfcd409b0c))
+* Filter logs correctly ([43fc20d](https://github.com/ReVanced/revanced-cli/commit/43fc20d90e0a694b231b17bb7d9ecfa22bb5d9a0))
+* Log correct options command ([#262](https://github.com/ReVanced/revanced-cli/issues/262)) ([96c196d](https://github.com/ReVanced/revanced-cli/commit/96c196dcb14e37ad91b751af61ee8382547c1ca3))
+* Log logs with levels over warning to error output stream ([075f6ad](https://github.com/ReVanced/revanced-cli/commit/075f6ad56528a667dca1f0bed704cf7e5381026f))
+* Only open files for reading and writing if writeable ([3846f72](https://github.com/ReVanced/revanced-cli/commit/3846f721ca015ab39a7e4b8d3f3d61163a6f1650))
+* Only set options for filtered patches ([64d9127](https://github.com/ReVanced/revanced-cli/commit/64d9127291ea9a8abe21a0e82721721495094472))
+
+
+### Features
+
+* Add function to get the most common compatible version ([77d9173](https://github.com/ReVanced/revanced-cli/commit/77d91735ffbbd6e733f08176f535bfd39ece0c29))
+* Add option to filter patches to be listed by package name ([50c0f98](https://github.com/ReVanced/revanced-cli/commit/50c0f98ce5927e07839437a2e550aa85f5a7e62d))
+* Add option to warn about patches not being found in supplied patch bundles ([e46d855](https://github.com/ReVanced/revanced-cli/commit/e46d85564320f46c6faa54b2d3fa7fca3fa60019))
+* Add ReVanced Library subproject ([#265](https://github.com/ReVanced/revanced-cli/issues/265)) ([157278c](https://github.com/ReVanced/revanced-cli/commit/157278c9ba25f0f786c5fe58e3e23f6890107118))
+* Do not format patch names ([80a8d88](https://github.com/ReVanced/revanced-cli/commit/80a8d88406b2b04d13dca4fb0d7d7d62e1910317))
+* Extend signing API ([592dc1c](https://github.com/ReVanced/revanced-cli/commit/592dc1c64ae4078e73bb71eba11380b301c79dea))
+* Improve option descriptions ([d5ea5a0](https://github.com/ReVanced/revanced-cli/commit/d5ea5a0ab1cc015730063e5be94ee18bd88cc906))
+* Log stacktrace in new line ([c67e3c7](https://github.com/ReVanced/revanced-cli/commit/c67e3c70c7eaa514cde1bebe775a2216bc4a6074))
+* Use ReVanced Library in ReVanced CLI ([7794327](https://github.com/ReVanced/revanced-cli/commit/7794327a11e8a0e0f28176cd45fad797b924c45f))
+* Word log message better ([6942b22](https://github.com/ReVanced/revanced-cli/commit/6942b22a68de5e991987ea89882915917aec93a3))
+
+
+### Performance Improvements
+
+* Do not check, if the options file exists twice ([e3c5550](https://github.com/ReVanced/revanced-cli/commit/e3c55507cf52e697b9ce9d59decc1cbe4cfe5b43))
+
+
+### BREAKING CHANGES
+
+* This changes many signatures of existing APIs and adds new functions for signing
+* This changes the log handler signature
+
+# [4.0.0-dev.5](https://github.com/ReVanced/revanced-cli/compare/v4.0.0-dev.4...v4.0.0-dev.5) (2023-10-04)
+
+
+### Bug Fixes
+
+* Only set options for filtered patches ([64d9127](https://github.com/ReVanced/revanced-cli/commit/64d9127291ea9a8abe21a0e82721721495094472))
+
+
+### Performance Improvements
+
+* Do not check, if the options file exists twice ([e3c5550](https://github.com/ReVanced/revanced-cli/commit/e3c55507cf52e697b9ce9d59decc1cbe4cfe5b43))
+
+# [4.0.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v4.0.0-dev.3...v4.0.0-dev.4) (2023-10-01)
+
+# [4.0.0-dev.3](https://github.com/ReVanced/revanced-cli/compare/v4.0.0-dev.2...v4.0.0-dev.3) (2023-09-27)
+
+# [4.0.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.0.0-dev.1...v4.0.0-dev.2) (2023-09-24)
+
+
+### Features
+
+* Improve option descriptions ([d5ea5a0](https://github.com/ReVanced/revanced-cli/commit/d5ea5a0ab1cc015730063e5be94ee18bd88cc906))
+
 # [4.0.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v3.1.2-dev.1...v4.0.0-dev.1) (2023-09-23)
 
 

CONTRIBUTING.md

@@ -39,7 +39,7 @@
    Continuing the legacy of Vanced
 </p>
 
-# 📙 ReVanced CLI contribution guidelines
+# 👋 Contribution guidelines
 
 This document describes how to contribute to ReVanced CLI.
 
@@ -76,4 +76,4 @@ If you encounter a bug while using ReVanced CLI, open an issue using the
    it will be merged into the `dev` branch and will be included in the next release of ReVanced CLI
 
 ❤️ Thank you for considering contributing to ReVanced CLI,
-ReVanced
+ReVanced

README.md

@@ -28,12 +28,15 @@
    <a href="https://t.me/app_revanced">
        <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
    </a>&nbsp;&nbsp;&nbsp;
-   <a href="https://twitter.com/revancedapp">
-       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032018-6da37214-7474-4641-a1da-7af7db3a31cd.png" />
+   <a href="https://x.com/revancedapp">
+      <picture>
+         <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+         <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+       <picture/>
    </a>&nbsp;&nbsp;&nbsp;
    <a href="https://www.youtube.com/@ReVanced">
        <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
-   </a>&nbsp;&nbsp;&nbsp;
+   </a>
    <br>
    <br>
    Continuing the legacy of Vanced

assets/revanced-logo/revanced-logo-round.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 800 800" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;"><g id="Logo"><g id="Ring"><circle id="Ring-Background" serif:id="Ring Background" cx="400" cy="400" r="400" style="fill:#1b1b1b;"/><path id="Ring1" serif:id="Ring" d="M400,0c220.766,0 400,179.234 400,400c-0,220.766 -179.234,400 -400,400c-220.766,-0 -400,-179.234 -400,-400c0,-220.766 179.234,-400 400,-400Zm-0,36c200.897,-0 364,163.103 364,364c0,200.897 -163.103,364 -364,364c-200.897,0 -364,-163.103 -364,-364c-0,-200.897 163.103,-364 364,-364Z" style="fill:url(#_Linear1);"/></g><g id="Shape"><path id="V-Shape" serif:id="V Shape" d="M538.74,269.872c1.481,-3.382 1.157,-7.283 -0.863,-10.373c-2.021,-3.091 -5.464,-4.954 -9.156,-4.954c-5.148,0 -10.435,0 -14.165,0c-3.1,0 -5.907,1.834 -7.153,4.672c-12.468,28.396 -78.273,178.273 -100.25,228.328c-1.246,2.838 -4.053,4.671 -7.154,4.671c-3.1,0 -5.907,-1.833 -7.153,-4.671c-21.977,-50.055 -87.782,-199.932 -100.25,-228.328c-1.246,-2.838 -4.053,-4.672 -7.153,-4.672c-3.73,0 -9.017,0 -14.164,0c-3.693,0 -7.135,1.863 -9.156,4.954c-2.02,3.09 -2.344,6.991 -0.863,10.373c23.557,53.766 101.872,232.519 117.871,269.034c1.743,3.979 5.674,6.549 10.018,6.549c6.293,-0 15.408,-0 21.701,-0c4.344,-0 8.275,-2.57 10.018,-6.549c15.999,-36.515 94.315,-215.268 117.872,-269.034Z" style="fill:#fff;"/><path id="Diamond" d="M408.119,395.312c-1.675,2.901 -4.77,4.688 -8.119,4.688c-3.349,-0 -6.444,-1.787 -8.119,-4.688c-16.997,-29.44 -56.156,-97.264 -73.153,-126.704c-1.675,-2.901 -1.675,-6.474 0,-9.375c1.675,-2.901 4.77,-4.688 8.119,-4.688c33.995,0 112.311,0 146.306,0c3.349,0 6.444,1.787 8.119,4.688c1.675,2.901 1.675,6.474 -0,9.375c-16.997,29.44 -56.156,97.264 -73.153,126.704Z" style="fill:url(#_Linear2);"/></g></g><defs><linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(4.89859e-14,800,-800,4.89859e-14,400.001,3.31681e-10)"><stop offset="0" style="stop-color:#f04e98;stop-opacity:1"/><stop offset="0.5" style="stop-color:#5f65d4;stop-opacity:1"/><stop offset="1" style="stop-color:#4e98f0;stop-opacity:1"/></linearGradient><linearGradient id="_Linear2" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(1.77155e-14,289.317,-282.535,1.73003e-14,400,254.545)"><stop offset="0" style="stop-color:#f04e98;stop-opacity:1"/><stop offset="0.5" style="stop-color:#5f65d4;stop-opacity:1"/><stop offset="1" style="stop-color:#4e98f0;stop-opacity:1"/></linearGradient></defs></svg>

build.gradle.kts

@@ -1,10 +1,17 @@
 plugins {
-    kotlin("jvm") version "1.9.0"
+    kotlin("jvm") version "1.9.10"
     alias(libs.plugins.shadow)
 }
 
 group = "app.revanced"
 
+repositories {
+    mavenCentral()
+    mavenLocal()
+    google()
+    maven { url = uri("https://jitpack.io") }
+}
+
 dependencies {
     implementation(libs.revanced.patcher)
     implementation(libs.revanced.library)

docs/0_prerequisites.md

@@ -1,14 +1,12 @@
 # 💼 Prerequisites
 
-To use ReVanced CLI, you will need to fulfil specific requirements.
+To use ReVanced CLI, you will need to fulfill specific requirements.
 
 ## 🤝 Requirements
 
 - Java SDK 11 (Azul Zulu JDK or OpenJDK)
 - [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to install 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)
-- ReVanced Patches
-- ReVanced Integrations, if the patches require it
 
 ## ⏭️ Whats next
 

docs/1_usage.md

@@ -2,36 +2,17 @@
 
 Learn how to ReVanced CLI.
 
-## ⚡ Setup ADB
+## 🔨 Usage
 
-1. Ensure that ADB is working
+ReVanced CLI is divided into the following fundamental commands:
 
-   ```bash
-   adb shell exit
-   ```
-
-   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 your device's serial
-
-   ```bash
-   adb devices
-   ```
-
-## 🔨 Using ReVanced CLI
-
-- ### ⚙️ Show all available options for ReVanced CLI
+- ### 🚀 Show all available options for ReVanced CLI
 
   ```bash
   java -jar revanced-cli.jar -h
   ```
 
-- ### 📃 List patches from supplied patch bundles
+- ### 📃 List patches
 
   ```bash
   java -jar revanced-cli.jar list-patches \
@@ -41,65 +22,95 @@ Learn how to ReVanced CLI.
    revanced-patches.jar [<patch-bundle> ...]
   ```
 
-- ### ⚙️ Generate options from patches using ReVanced CLI
+- ### ⚙️ Generate 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
+  ```bash
   java -jar revanced-cli.jar options \
    --path options.json \
    --overwrite \
    revanced-patches.jar [<patch-bundle> ...]
   ```
 
-  > **Note**: A default `options.json` file will be automatically generated, if it does not exist 
+  > [!NOTE]  
+  > A default `options.json` file will be automatically created, if it does not exist 
   without any need for intervention when using the `patch` command.
 
-- ### 💉 Use ReVanced CLI to patch an APK file but install without root permissions
+- ### 💉 Patch an app
 
-  This will install the patched APK file regularly on your device.
+  You can patch apps by supplying patch bundles and the app to patch.
+  After patching, ReVanced CLI can install the patched app on your device using two methods:
 
-  ```bash
-  java -jar revanced-cli.jar patch \
-   --patch-bundle revanced-patches.jar \
-   --out output.apk \
-   --device-serial <device-serial> \
-   input.apk
-  ```
+  > [!NOTE]  
+  > For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working:
+  >
+  > ```bash
+  > adb shell exit
+  > ```
+  >
+  > To get your device's serial, run the following command:
+  >
+  > ```bash
+  > adb devices
+  > ```
+  >
+  > If you want to mount the patched app on top of the un-patched app, make sure you have root permissions:
+  >
+  > ```bash
+  > adb shell su -c exit
+  > ```
+  >
 
-- ### 👾 Use ReVanced CLI to patch an APK file but install with root permissions
+  > [!WARNING]  
+  > Some patches may require integrations
+  > such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations).
+  > Supply them with the option `--merge`. ReVanced Patcher will automatically determine if they are necessary.
 
-  This will install the patched APK file on your device by mounting it on top of the original APK file.
+  - #### 👾 Patch an app and install it on your device regularly
 
-  ```bash
-  adb install input.apk
-  java -jar revanced-cli.jar patch \
-   --patch-bundle revanced-patches.jar \
-   --include some-other-patch \
-   --exclude some-patch \
-   --out patched-output.apk \
-   --device-serial <device-serial> \
-   --mount \
-   input.apk
-  ```
+    ```bash
+    java -jar revanced-cli.jar patch \
+     --patch-bundle revanced-patches.jar \
+     --out patched-app.apk \
+     --device-serial <device-serial> \
+     input.apk
+    ```
 
-  > **Note**: Some patches may require integrations
-  such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations). 
-  Supply them with the option `--merge`. If any patches accepted by ReVanced Patcher require ReVanced Integrations, 
-  they will be merged into the APK file automatically.
+  - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions
+  
+    > [!IMPORTANT]  
+    > Ensure sure the same app you are patching and mounting over is installed on your device:
+    > 
+    > ```bash
+    > adb install app.apk
+    > ```
+
+    ```bash
+    java -jar revanced-cli.jar patch \
+     --patch-bundle revanced-patches.jar \
+     --include "Some patch" \
+     --exclude "Some other patch" \
+     --out patched-app.apk \
+     --device-serial <device-serial> \
+     --mount \
+     app.apk
+    ```
+
+- ### 🗑️ Uninstall an app
 
-- ### 🗑️ Uninstall a patched APK file
   ```bash
   java -jar revanced-cli.jar utility uninstall \
    --package-name <package-name> \
    <device-serial>
   ```
 
-  > **Note**: You can unmount an APK file
-  with the option `--unmount`.
+  > [!NOTE]  
+  > You can unmount an APK file
+  by adding the option `--unmount`.
 
-- ### ️ ⚙️ Manually install an APK file
+- ### ️ 📦 Install an app
 
   ```bash
   java -jar revanced-cli.jar utility install \
@@ -107,5 +118,6 @@ Learn how to ReVanced CLI.
    <device-serial>
   ```
 
-  > **Note**: You can mount an APK file 
-  by supplying the package name of the app to mount the supplied APK file to over the option `--mount`.
+  > [!NOTE]  
+  > You can mount an APK file 
+  > by supplying the package name of the app to mount the supplied APK file to over the option `--mount`.

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 4.0.0-dev.1
+version = 4.0.3-dev.1

gradle/libs.versions.toml

@@ -3,8 +3,8 @@ shadow = "8.1.1"
 kotlin-test = "1.8.20-RC"
 kotlinx-coroutines-core = "1.7.3"
 picocli = "4.7.3"
-revanced-patcher = "15.0.1"
-revanced-library = "1.0.0"
+revanced-patcher = "18.0.0"
+revanced-library = "1.1.5"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin-test" }

settings.gradle.kts

@@ -1,23 +1 @@
-val githubUsername: String = providers.gradleProperty("gpr.user").orNull ?: System.getenv("GITHUB_ACTOR")
-val githubPassword: String = providers.gradleProperty("gpr.key").orNull ?: System.getenv("GITHUB_TOKEN")
-
-dependencyResolutionManagement {
-    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
-    repositories {
-        mavenCentral()
-        mavenLocal()
-        google()
-        maven { url = uri("https://jitpack.io") }
-        listOf("revanced-patcher", "jadb").forEach { repo ->
-            maven {
-                url = uri("https://maven.pkg.github.com/revanced/$repo")
-                credentials {
-                    username = githubUsername
-                    password = githubPassword
-                }
-            }
-        }
-    }
-}
-
 rootProject.name = "revanced-cli"

src/main/kotlin/app/revanced/cli/command/ListPatchesCommand.kt

@@ -9,41 +9,41 @@ import java.io.File
 import java.util.logging.Logger
 
 
-@Command(name = "list-patches", description = ["List patches from supplied patch bundles"])
+@Command(name = "list-patches", description = ["List patches from supplied patch bundles."])
 internal object ListPatchesCommand : Runnable {
     private val logger = Logger.getLogger(ListPatchesCommand::class.java.name)
 
     @Parameters(
-        description = ["Paths to patch bundles"], arity = "1..*"
+        description = ["Paths to patch bundles."], arity = "1..*"
     )
     private lateinit var patchBundles: Array<File>
 
     @Option(
-        names = ["-d", "--with-descriptions"], description = ["List their descriptions"], showDefaultValue = ALWAYS
+        names = ["-d", "--with-descriptions"], description = ["List their descriptions."], showDefaultValue = ALWAYS
     )
     private var withDescriptions: Boolean = true
 
     @Option(
         names = ["-p", "--with-packages"],
-        description = ["List the packages the patches are compatible with"],
+        description = ["List the packages the patches are compatible with."],
         showDefaultValue = ALWAYS
     )
     private var withPackages: Boolean = false
 
     @Option(
         names = ["-v", "--with-versions"],
-        description = ["List the versions of the apps the patches are compatible with"],
+        description = ["List the versions of the apps the patches are compatible with."],
         showDefaultValue = ALWAYS
     )
     private var withVersions: Boolean = false
 
     @Option(
-        names = ["-o", "--with-options"], description = ["List the options of the patches"], showDefaultValue = ALWAYS
+        names = ["-o", "--with-options"], description = ["List the options of the patches."], showDefaultValue = ALWAYS
     )
     private var withOptions: Boolean = false
 
     @Option(
-        names = ["-f", "--filter-package-name"], description = ["Filter patches by package name"]
+        names = ["-f", "--filter-package-name"], description = ["Filter patches by package name."]
     )
     private var packageName: String? = null
 
@@ -58,12 +58,16 @@ internal object ListPatchesCommand : Runnable {
 
         fun PatchOption<*>.buildString() = buildString {
             appendLine("Title: $title")
-            appendLine("Description: $description")
-
-            value?.let {
+            description?.let { appendLine("Description: $it") }
+            default?.let {
                 appendLine("Key: $key")
-                append("Value: $it")
+                append("Default: $it")
             } ?: append("Key: $key")
+
+            values?.let { values ->
+                appendLine("\nValid values:")
+                append(values.map { "${it.value} (${it.key})" }.joinToString("\n").prependIndent("\t"))
+            }
         }
 
         fun Patch<*>.buildString() = buildString {

src/main/kotlin/app/revanced/cli/command/MainCommand.kt

@@ -26,7 +26,7 @@ private object CLIVersionProvider : IVersionProvider {
 
 @Command(
     name = "revanced-cli",
-    description = ["Command line application to use ReVanced"],
+    description = ["Command line application to use ReVanced."],
     mixinStandardHelpOptions = true,
     versionProvider = CLIVersionProvider::class,
     subcommands = [

src/main/kotlin/app/revanced/cli/command/OptionsCommand.kt

@@ -10,37 +10,38 @@ import java.util.logging.Logger
 
 @CommandLine.Command(
     name = "options",
-    description = ["Generate options file from patches"],
+    description = ["Generate options file from patches."],
 )
 internal object OptionsCommand : Runnable {
     private val logger = Logger.getLogger(OptionsCommand::class.java.name)
 
     @CommandLine.Parameters(
-        description = ["Paths to patch bundles"], arity = "1..*"
+        description = ["Paths to patch bundles."], arity = "1..*"
     )
     private lateinit var patchBundles: Array<File>
 
     @CommandLine.Option(
-        names = ["-p", "--path"], description = ["Path to patch options JSON file"], showDefaultValue = ALWAYS
+        names = ["-p", "--path"], description = ["Path to patch options JSON file."], showDefaultValue = ALWAYS
     )
     private var filePath: File = File("options.json")
 
     @CommandLine.Option(
-        names = ["-o", "--overwrite"], description = ["Overwrite existing options file"], showDefaultValue = ALWAYS
+        names = ["-o", "--overwrite"], description = ["Overwrite existing options file."], showDefaultValue = ALWAYS
     )
     private var overwrite: Boolean = false
 
     @CommandLine.Option(
         names = ["-u", "--update"],
-        description = ["Update existing options by adding missing and removing non-existent options"],
+        description = ["Update existing options by adding missing and removing non-existent options."],
         showDefaultValue = ALWAYS
     )
     private var update: Boolean = false
 
     override fun run() = try {
         PatchBundleLoader.Jar(*patchBundles).let { patches ->
-            if (!filePath.exists() || overwrite) {
-                if (update && filePath.exists()) patches.setOptions(filePath)
+            val exists = filePath.exists()
+            if (!exists || overwrite) {
+                if (exists && update) patches.setOptions(filePath)
 
                 Options.serialize(patches, prettyPrint = true).let(filePath::writeText)
             } else throw OptionsFileAlreadyExistsException()

src/main/kotlin/app/revanced/cli/command/PatchCommand.kt

@@ -20,7 +20,7 @@ import java.util.logging.Logger
 
 
 @CommandLine.Command(
-    name = "patch", description = ["Patch an APK file"]
+    name = "patch", description = ["Patch an APK file."]
 )
 internal object PatchCommand : Runnable {
     private val logger = Logger.getLogger(PatchCommand::class.java.name)
@@ -35,104 +35,104 @@ internal object PatchCommand : Runnable {
     private var patchBundles = emptyList<File>()
 
     @CommandLine.Option(
-        names = ["-i", "--include"], description = ["List of patches to include"]
+        names = ["-i", "--include"], description = ["List of patches to include."]
     )
     private var includedPatches = arrayOf<String>()
 
     @CommandLine.Option(
-        names = ["-e", "--exclude"], description = ["List of patches to exclude"]
+        names = ["-e", "--exclude"], description = ["List of patches to exclude."]
     )
     private var excludedPatches = arrayOf<String>()
 
     @CommandLine.Option(
-        names = ["--options"], description = ["Path to patch options JSON file"], showDefaultValue = ALWAYS
+        names = ["--options"], description = ["Path to patch options JSON file."], showDefaultValue = ALWAYS
     )
     private var optionsFile: File = File("options.json")
 
     @CommandLine.Option(
         names = ["--exclusive"],
-        description = ["Only include patches that are explicitly specified to be included"],
+        description = ["Only include patches that are explicitly specified to be included."],
         showDefaultValue = ALWAYS
     )
     private var exclusive = false
 
     @CommandLine.Option(
         names = ["-f","--force"],
-        description = ["Force inclusion of patches that are incompatible with the supplied APK file's version"],
+        description = ["Bypass compatibility checks for the supplied APK's version."],
         showDefaultValue = ALWAYS
     )
     private var force: Boolean = false
 
     @CommandLine.Option(
-        names = ["-o", "--out"], description = ["Path to save the patched APK file to"], required = true
+        names = ["-o", "--out"], description = ["Path to save the patched APK file to."], required = true
     )
     private lateinit var outputFilePath: File
 
     @CommandLine.Option(
-        names = ["-d", "--device-serial"], description = ["ADB device serial to install to"], showDefaultValue = ALWAYS
+        names = ["-d", "--device-serial"], description = ["ADB device serial to install to."], showDefaultValue = ALWAYS
     )
     private var deviceSerial: String? = null
 
     @CommandLine.Option(
-        names = ["--mount"], description = ["Install by mounting the patched APK file"], showDefaultValue = ALWAYS
+        names = ["--mount"], description = ["Install by mounting the patched APK file."], showDefaultValue = ALWAYS
     )
     private var mount: Boolean = false
 
     @CommandLine.Option(
-        names = ["--keystore"], description = ["Path to the keystore to sign the patched APK file with"],
+        names = ["--keystore"], description = ["Path to the keystore to sign the patched APK file with."],
     )
     private var keystoreFilePath: File? = null
 
     // key store password
     @CommandLine.Option(
         names = ["--keystore-password"],
-        description = ["The password of the keystore to sign the patched APK file with"],
+        description = ["The password of the keystore to sign the patched APK file with."],
     )
     private var keyStorePassword: String? = null // Empty password by default
 
     @CommandLine.Option(
-        names = ["--alias"], description = ["The alias of the key from the keystore to sign the patched APK file with"],
+        names = ["--alias"], description = ["The alias of the key from the keystore to sign the patched APK file with."],
         showDefaultValue = ALWAYS
     )
     private var alias = "ReVanced Key"
 
     @CommandLine.Option(
         names = ["--keystore-entry-password"],
-        description = ["The password of the entry from the keystore for the key to sign the patched APK file with"]
+        description = ["The password of the entry from the keystore for the key to sign the patched APK file with."]
     )
     private var password = "" // Empty password by default
 
     @CommandLine.Option(
-        names = ["--signer"], description = ["The name of the signer to sign the patched APK file with"],
+        names = ["--signer"], description = ["The name of the signer to sign the patched APK file with."],
         showDefaultValue = ALWAYS
     )
     private var signer = "ReVanced"
 
     @CommandLine.Option(
         names = ["-r", "--resource-cache"],
-        description = ["Path to temporary resource cache directory"],
+        description = ["Path to temporary resource cache directory."],
         showDefaultValue = ALWAYS
     )
-    private var resourceCachePath = File("revanced-resource-cache")
+    private var resourceCachePath = File("revanced-resource-cache.")
 
     private var aaptBinaryPath: File? = null
 
     @CommandLine.Option(
         names = ["-p", "--purge"],
-        description = ["Purge the temporary resource cache directory after patching"],
+        description = ["Purge the temporary resource cache directory after patching."],
         showDefaultValue = ALWAYS
     )
     private var purge: Boolean = false
 
     @CommandLine.Option(
         names = ["-w", "--warn"],
-        description = ["Warn if a patch can not be found in the supplied patch bundles"],
+        description = ["Warn if a patch can not be found in the supplied patch bundles."],
         showDefaultValue = ALWAYS
     )
     private var warn: Boolean = false
 
     @CommandLine.Parameters(
-        description = ["APK file to be patched"], arity = "1..1"
+        description = ["APK file to be patched."], arity = "1..1"
     )
     @Suppress("unused")
     private fun setApk(apk: File) {
@@ -144,18 +144,18 @@ internal object PatchCommand : Runnable {
     }
 
     @CommandLine.Option(
-        names = ["-m", "--merge"], description = ["One or more DEX files or containers to merge into the APK"]
+        names = ["-m", "--merge"], description = ["One or more DEX files or containers to merge into the APK."]
     )
     @Suppress("unused")
     private fun setIntegrations(integrations: Array<File>) {
         integrations.firstOrNull { !it.exists() }?.let {
-            throw CommandLine.ParameterException(spec.commandLine(), "Integrations file ${it.name} does not exist")
+            throw CommandLine.ParameterException(spec.commandLine(), "Integrations file ${it.name} does not exist.")
         }
         this.integrations += integrations
     }
 
     @CommandLine.Option(
-        names = ["-b", "--patch-bundle"], description = ["One or more bundles of patches"], required = true
+        names = ["-b", "--patch-bundle"], description = ["One or more bundles of patches."], required = true
     )
     @Suppress("unused")
     private fun setPatchBundles(patchBundles: Array<File>) {
@@ -166,7 +166,7 @@ internal object PatchCommand : Runnable {
     }
 
     @CommandLine.Option(
-        names = ["--custom-aapt2-binary"], description = ["Path to a custom AAPT binary to compile resources with"]
+        names = ["--custom-aapt2-binary"], description = ["Path to a custom AAPT binary to compile resources with."]
     )
     @Suppress("unused")
     private fun setAaptBinaryPath(aaptBinaryPath: File) {
@@ -196,13 +196,6 @@ internal object PatchCommand : Runnable {
             logger.warning("Unknown input of patches:\n${unknownPatches.joinToString("\n")}")
         }
 
-        logger.info("Setting patch options")
-
-        optionsFile.let {
-            if (it.exists()) patches.setOptions(it)
-            else Options.serialize(patches, prettyPrint = true).let(it::writeText)
-        }
-
         // endregion
 
         Patcher(
@@ -211,13 +204,21 @@ internal object PatchCommand : Runnable {
                 resourceCachePath,
                 aaptBinaryPath?.path,
                 resourceCachePath.absolutePath,
+                true
             )
         ).use { patcher ->
+            val filteredPatches = patcher.filterPatchSelection(patches).also { patches ->
+                logger.info("Setting patch options")
+
+                if (optionsFile.exists()) patches.setOptions(optionsFile)
+                else Options.serialize(patches, prettyPrint = true).let(optionsFile::writeText)
+            }
+
             // region Patch
 
             val patcherResult = patcher.apply {
                 acceptIntegrations(integrations)
-                acceptPatches(filterPatchSelection(patches))
+                acceptPatches(filteredPatches.toList())
 
                 // Execute patches.
                 runBlocking {
@@ -236,7 +237,7 @@ internal object PatchCommand : Runnable {
 
             // region Save
 
-            val tempFile = resourceCachePath.resolve(apk.name).apply {
+            val alignedFile = resourceCachePath.resolve(apk.name).apply {
                 ApkUtils.copyAligned(apk, this, patcherResult)
             }
 
@@ -244,7 +245,7 @@ internal object PatchCommand : Runnable {
                 .resolve("${outputFilePath.nameWithoutExtension}.keystore")
 
             if (!mount) ApkUtils.sign(
-                tempFile,
+                alignedFile,
                 outputFilePath,
                 ApkUtils.SigningOptions(
                     keystoreFilePath,
@@ -254,6 +255,7 @@ internal object PatchCommand : Runnable {
                     signer
                 )
             )
+            else alignedFile.renameTo(outputFilePath)
 
             // endregion
 
@@ -277,7 +279,7 @@ internal object PatchCommand : Runnable {
      * @param patches The patches to filter.
      * @return The filtered patches.
      */
-    private fun Patcher.filterPatchSelection(patches: PatchSet) = buildList {
+    private fun Patcher.filterPatchSelection(patches: PatchSet): PatchSet = buildSet {
         val packageName = context.packageMetadata.packageName
         val packageVersion = context.packageMetadata.packageVersion
 
@@ -298,7 +300,7 @@ internal object PatchCommand : Runnable {
                         "$patchName is incompatible with version $packageVersion. "
                                 + "This patch is only compatible with version "
                                 + packages.joinToString(";") { pkg ->
-                            "${pkg.name}: ${pkg.versions!!.joinToString(", ")}"
+                            pkg.versions!!.joinToString(", ")
                         }
                     )
                 } ?: return@patch logger.fine(