chore(release): 3.0.0-dev.6 [skip ci]

# [3.0.0-dev.6](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.5...v3.0.0-dev.6) (2023-08-24)

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

.github/config.yml

@@ -0,0 +1,2 @@
+firstPRMergeComment: >
+  Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) if you want to receive a contributor role.

.github/workflows/release.yml

@@ -23,17 +23,21 @@ jobs:
           # https://github.com/cycjimmy/semantic-release-action#private-packages
           persist-credentials: false
           fetch-depth: 0
-      - name: Setup JDK
-        uses: actions/setup-java@v3
+      - name: Cache
+        uses: actions/cache@v3
         with:
-          java-version: '17'
-          distribution: 'zulu'
-          cache: gradle
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "18"
-          cache: 'npm'
+          path: |
+            ${{ runner.home }}/.gradle/caches
+            ${{ runner.home }}/.gradle/wrapper
+            .gradle
+            build
+            node_modules
+          key: ${{ runner.os }}-gradle-npm-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties', 'package-lock.json') }}
+      - name: Build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # Cleaning is necessary to avoid uploading two identical artifacts with different versions
+        run: ./gradlew clean --no-daemon
       - name: Setup semantic-release
         run: npm install
       - name: Release

.github/workflows/update-documentation.yml

@@ -9,6 +9,7 @@ jobs:
   trigger:
     runs-on: ubuntu-latest
     name: Dispatch event to documentation repository
+    if: github.ref == 'refs/heads/main'
     steps:
       - uses: peter-evans/repository-dispatch@v2
         with:

.releaserc

@@ -7,7 +7,13 @@
     }
   ],
   "plugins": [
-    "@semantic-release/commit-analyzer",
+    [
+      "@semantic-release/commit-analyzer", {
+        "releaseRules": [
+          { "type": "build", "scope": "Needs bump", "release": "patch" }
+        ]
+      }
+    ],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
     "gradle-semantic-release-plugin",

CHANGELOG.md

@@ -1,3 +1,171 @@
+# [3.0.0-dev.6](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.5...v3.0.0-dev.6) (2023-08-24)
+
+# [3.0.0-dev.5](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.4...v3.0.0-dev.5) (2023-08-24)
+
+
+### Bug Fixes
+
+* also delete temporary files when uninstalling ([52c3be2](https://github.com/ReVanced/revanced-cli/commit/52c3be23f2915dccaee7f9941413c8f81e14acc8))
+* delete temporary files after root installation ([a3d8705](https://github.com/ReVanced/revanced-cli/commit/a3d8705e89732a0dd4f51de28c405b6af13c8633))
+* fix running commands not running ([2c7fcaf](https://github.com/ReVanced/revanced-cli/commit/2c7fcaf4add65a12052afc5bef779dbc73debd69))
+* only check once for patch options ([11c3a6c](https://github.com/ReVanced/revanced-cli/commit/11c3a6cfd4fe59ba5d703358634a1853e1cc22a5))
+
+
+### Features
+
+* add install command ([0350b7f](https://github.com/ReVanced/revanced-cli/commit/0350b7f1a276d9dc795b22442ba4f202855ea090))
+* use friendly descriptions ([3dd875d](https://github.com/ReVanced/revanced-cli/commit/3dd875d14cca488ade6d21bbd4cce0d481692134))
+
+# [3.0.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.3...v3.0.0-dev.4) (2023-08-24)
+
+
+### Features
+
+* properly make use of logging facade ([41898d7](https://github.com/ReVanced/revanced-cli/commit/41898d7547690e3130372414515c5645e5dc2634))
+
+# [3.0.0-dev.3](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.2...v3.0.0-dev.3) (2023-08-23)
+
+# [3.0.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.1...v3.0.0-dev.2) (2023-08-23)
+
+
+### Bug Fixes
+
+* specify correct class containing entry-point ([1fcc591](https://github.com/ReVanced/revanced-cli/commit/1fcc591222ab67112f2b78174a8b94106846838c))
+
+# [3.0.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.5...v3.0.0-dev.1) (2023-08-23)
+
+
+### Bug Fixes
+
+* do not use absolute path from custom AAPT2 binary option ([a9c2a5f](https://github.com/ReVanced/revanced-cli/commit/a9c2a5f096627dbbf8ab1b8da26fb14529ce6bc3))
+* use correct option name ([f8972ea](https://github.com/ReVanced/revanced-cli/commit/f8972eac3e5ee0a4a186c12cbe711925656d657b))
+
+
+* refactor!: restructure code ([07da528](https://github.com/ReVanced/revanced-cli/commit/07da528ce2223582f84bf64d2fec69714c647ddc))
+
+
+### Features
+
+* add options command ([9edbbf3](https://github.com/ReVanced/revanced-cli/commit/9edbbf31635603f89fc7bc5dcc6c023d4cdbb5a6))
+* use better logging text ([b0e748d](https://github.com/ReVanced/revanced-cli/commit/b0e748daff527ee7f417b3069882e074896fc131))
+* use separate command to list patches ([b74213f](https://github.com/ReVanced/revanced-cli/commit/b74213f66e0d04d3a0ae6197d069631388e06580))
+* use separate command to patch ([32da961](https://github.com/ReVanced/revanced-cli/commit/32da961d57537e99b39fd92b625a1c73f8314bc6))
+* use separate command to uninstall ([c0cc909](https://github.com/ReVanced/revanced-cli/commit/c0cc90962646cfffd5e2730ae556423271a7990b))
+* use simpler log ([ba758f0](https://github.com/ReVanced/revanced-cli/commit/ba758f00f4ce18791439b7e72fe1ad2e7f11f8af))
+
+
+### BREAKING CHANGES
+
+* This introduces major changes to how ReVanced CLI is used from the command line.
+
+# [2.23.0-dev.5](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.4...v2.23.0-dev.5) (2023-08-14)
+
+# [2.23.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.3...v2.23.0-dev.4) (2023-08-13)
+
+
+### Features
+
+* show full package name when listing patches ([#240](https://github.com/ReVanced/revanced-cli/issues/240)) ([7174364](https://github.com/ReVanced/revanced-cli/commit/7174364ef8ef5d6ce8351a8340f9c1a5b58eac3c))
+
+# [2.23.0-dev.3](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.2...v2.23.0-dev.3) (2023-08-03)
+
+# [2.23.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.1...v2.23.0-dev.2) (2023-08-03)
+
+# [2.23.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v2.22.1-dev.1...v2.23.0-dev.1) (2023-07-30)
+
+
+### Features
+
+* Improve command line argument descriptions ([f9cf7d2](https://github.com/ReVanced/revanced-cli/commit/f9cf7d21b7f1c2f11234d604a1047b9d2b165f83))
+
+## [2.22.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v2.22.0...v2.22.1-dev.1) (2023-07-24)
+
+
+### Bug Fixes
+
+* print original instead of kebab cased names ([5eaad33](https://github.com/ReVanced/revanced-cli/commit/5eaad33dc1fbd24c36e1498f04e21d068e85f53e))
+
+# [2.22.0](https://github.com/revanced/revanced-cli/compare/v2.21.5...v2.22.0) (2023-07-11)
+
+
+### Features
+
+* use new patch naming convention ([f6c221d](https://github.com/revanced/revanced-cli/commit/f6c221d72dc43ebea00e5eba6bfa02751ae8ad77))
+
+# [2.22.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.5...v2.22.0-dev.1) (2023-07-10)
+
+
+### Features
+
+* use new patch naming convention ([e4908c7](https://github.com/revanced/revanced-cli/commit/e4908c71051a535f8ce3406427cebbb0941464df))
+
+## [2.21.5](https://github.com/revanced/revanced-cli/compare/v2.21.4...v2.21.5) (2023-07-01)
+
+## [2.21.5-dev.2](https://github.com/revanced/revanced-cli/compare/v2.21.5-dev.1...v2.21.5-dev.2) (2023-07-01)
+
+## [2.21.5-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.4...v2.21.5-dev.1) (2023-06-27)
+
+## [2.21.4](https://github.com/revanced/revanced-cli/compare/v2.21.3...v2.21.4) (2023-06-21)
+
+
+### Bug Fixes
+
+* remove duplicate options entries. ([d0fc886](https://github.com/revanced/revanced-cli/commit/d0fc8864286adc2677f91a319a11a90272c1001d))
+
+## [2.21.4-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.3...v2.21.4-dev.1) (2023-06-18)
+
+
+### Bug Fixes
+
+* remove duplicate options entries. ([d0fc886](https://github.com/revanced/revanced-cli/commit/d0fc8864286adc2677f91a319a11a90272c1001d))
+
+## [2.21.3](https://github.com/revanced/revanced-cli/compare/v2.21.2...v2.21.3) (2023-06-12)
+
+## [2.21.3-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.2...v2.21.3-dev.1) (2023-06-07)
+
+## [2.21.2](https://github.com/revanced/revanced-cli/compare/v2.21.1...v2.21.2) (2023-05-24)
+
+## [2.21.2-dev.2](https://github.com/revanced/revanced-cli/compare/v2.21.2-dev.1...v2.21.2-dev.2) (2023-05-15)
+
+## [2.21.2-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.1...v2.21.2-dev.1) (2023-05-07)
+
+## [2.21.1](https://github.com/revanced/revanced-cli/compare/v2.21.0...v2.21.1) (2023-05-06)
+
+## [2.21.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.0...v2.21.1-dev.1) (2023-05-06)
+
+# [2.21.0](https://github.com/revanced/revanced-cli/compare/v2.20.2...v2.21.0) (2023-05-04)
+
+
+### Bug Fixes
+
+* **tests:** set order of tests ([2ef48af](https://github.com/revanced/revanced-cli/commit/2ef48af1b339ab729a05d69cb0c8c1ee1e3ab486))
+* use working JADB dependency version ([#222](https://github.com/revanced/revanced-cli/issues/222)) ([da2c918](https://github.com/revanced/revanced-cli/commit/da2c91874d5623402febfcc0677ada3d648565e1))
+
+
+### Features
+
+* add appreciation message for new contributors ([6962fc2](https://github.com/revanced/revanced-cli/commit/6962fc2f4c0f0c96e88a823be64f8ebd1312ee17))
+
+# [2.21.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.2...v2.21.0-dev.1) (2023-05-04)
+
+
+### Bug Fixes
+
+* **tests:** set order of tests ([2ef48af](https://github.com/revanced/revanced-cli/commit/2ef48af1b339ab729a05d69cb0c8c1ee1e3ab486))
+* use working JADB dependency version ([#222](https://github.com/revanced/revanced-cli/issues/222)) ([da2c918](https://github.com/revanced/revanced-cli/commit/da2c91874d5623402febfcc0677ada3d648565e1))
+
+
+### Features
+
+* add appreciation message for new contributors ([6962fc2](https://github.com/revanced/revanced-cli/commit/6962fc2f4c0f0c96e88a823be64f8ebd1312ee17))
+
+## [2.20.2](https://github.com/revanced/revanced-cli/compare/v2.20.1...v2.20.2) (2023-04-30)
+
+
+### Bug Fixes
+
+* correct spelling mistake ([31fb316](https://github.com/revanced/revanced-cli/commit/31fb3166d922ae1f568f52e44cbe726dd1c891a4))
+
 ## [2.20.2-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.1...v2.20.2-dev.1) (2023-04-03)
 
 

README.md

@@ -0,0 +1,3 @@
+# 💻 ReVanced CLI
+
+Command line application to use ReVanced.

build.gradle.kts

@@ -1,45 +1,39 @@
 plugins {
-    kotlin("jvm") version "1.8.10"
-    id("com.github.johnrengelman.shadow") version "7.1.2"
+    kotlin("jvm") version "1.8.20"
+    alias(libs.plugins.shadow)
 }
 
 group = "app.revanced"
 
-val githubUsername: String = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR")
-val githubPassword: String = project.findProperty("gpr.key") as? String ?: System.getenv("GITHUB_TOKEN")
-
-repositories {
-    mavenCentral()
-    mavenLocal()
-    maven {
-        url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
-        credentials {
-            username = githubUsername
-            password = githubPassword
-        }
-    }
-    maven { url = uri("https://jitpack.io") }
-    google()
-}
-
 dependencies {
-    implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.10")
-
-    implementation("app.revanced:revanced-patcher:7.0.0")
-    implementation("info.picocli:picocli:4.7.1")
-    implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork
-    implementation("com.android.tools.build:apksig:7.2.2")
-    implementation("org.bouncycastle:bcpkix-jdk15on:1.70")
-    implementation("cc.ekblad:4koma:1.1.0")
+    implementation(libs.revanced.patcher)
+    implementation(libs.kotlin.reflect)
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.picocli)
+    implementation(libs.jadb) // Updated fork
+    implementation(libs.apksig)
+    implementation(libs.bcpkix.jdk15on)
+    implementation(libs.jackson.module.kotlin)
+    testImplementation(libs.kotlin.test)
 }
 
+kotlin { jvmToolchain(11) }
+
 tasks {
-    build {
-        dependsOn(shadowJar)
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events("PASSED", "SKIPPED", "FAILED")
+        }
     }
+
+    processResources {
+        expand("projectVersion" to project.version)
+    }
+
     shadowJar {
         manifest {
-            attributes("Main-Class" to "app.revanced.cli.main.MainKt")
+            attributes("Main-Class" to "app.revanced.cli.command.MainCommandKt")
         }
         minimize {
             exclude(dependency("org.jetbrains.kotlin:.*"))
@@ -47,6 +41,11 @@ tasks {
             exclude(dependency("app.revanced:.*"))
         }
     }
+
+    build {
+        dependsOn(shadowJar)
+    }
+
     // Dummy task to fix the Gradle semantic-release plugin.
     // Remove this if you forked it to support building only.
     // Tracking issue: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435

docs/0_prerequisites.md

@@ -1,17 +1,17 @@
 # 💼 Prerequisites
 
-To use the ReVanced CLI, you will need to fulfill certain requirements.
+To use ReVanced CLI, you will need to fulfil specific requirements.
 
 ## 🤝 Requirements
 
-- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb), the command-line tool that lets
-  you communicate with a device (optional).
-- A x86/x86_64 host (or a custom AAPT binary for your architecture)
-- Zulu OpenJDK 17
-- An APK file (e.g. YouTube v17.49.37 or YouTube Music v5.36.51)
+- 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
 
-The next section will show, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
+The following section will show you how to use ReVanced CLI.
 
-Continue: [🛠️ Using the ReVanced CLI](1_usage.md)
+Continue: [🛠️ Using ReVanced CLI](1_usage.md)

docs/1_usage.md

@@ -1,74 +1,111 @@
-# 🛠️ Using the ReVanced CLI
+# 🛠️ Using ReVanced CLI
 
-Lean how to use the 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
    adb shell exit
    ```
 
-   If you plan to use the root variant, check if you have root access
+   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. Copy the ADB device name
+2. Get your device's serial
 
    ```bash
    adb devices
    ```
 
-## 🔨 ReVanced CLI Usage
+## 🔨 Using ReVanced CLI
 
-- ### Show all available options for the ReVanced CLI
+- ### ⚙️ Show all available options for ReVanced CLI
 
   ```bash
   java -jar revanced-cli.jar -h
   ```
 
-- ### List all available patches from supplied patch bundles
+- ### 📃 List patches from supplied patch bundles
 
   ```bash
-  java -jar revanced-cli.jar \
-      -b revanced-patches.jar \
-      -l
+  java -jar revanced-cli.jar list-patches \
+   --with-packages \
+   --with-versions \
+   --with-options \
+   revanced-patches.jar [<patch-bundle> ...]
   ```
 
-- ### Use the ReVanced CLI without root permissions
+- ### ⚙️ Generate options from patches using ReVanced CLI
+
+  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 \
+   revanced-patches.jar [<patch-bundle> ...]
+  ```
+
+  > **Note**: A default `options.json` file will be automatically generated, 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
+
+  This will install the patched APK file regularly on your device.
 
   ```bash
-  java -jar revanced-cli.jar \
+  java -jar revanced-cli.jar patch \
+   --patch-bundle revanced-patches.jar \
+   --out output.apk \
+   --device-serial <device-serial> \
+   input.apk
+  ```
+
+- ### 👾 Use ReVanced CLI to patch an APK file but install with root permissions
+
+  This will install the patched APK file on your device by mounting it on top of the original APK file.
+
+  ```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
+  ```
+
+  > **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.
+
+- ### 🗑️ 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`.
+
+- ### ️ ⚙️ Manually install an APK file
+
+  ```bash
+  java -jar revanced-cli.jar utility install \
    -a input.apk \
-   -o patched-output.apk \
-   -b revanced-patches.jar
+   <device-serial>
   ```
 
-- ### Mount the patched application with root permissions over the installed application
-
-  ```bash
-  adb install input.apk # make sure the same version is installed
-  java -jar revanced-cli.jar \
-      -a input.apk \
-      -d device-name \
-      -o patched-output.apk \
-      -b revanced-patches.jar \
-      -e microg-support \
-      --mount
-  ```
-
-> **Note**:
->
-> - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you can exclude
-    the `microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
-    option `-e microg-support` when mounting for example.
->
-> - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require
-    [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`.
-    > The integrations will be merged, if necessary automatically, if supplied.
->
-> - If you supplied a device with the option `-d`, the patched application will be automatically installed on the
-    device.
+  > **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`.

docs/README.md

@@ -1,8 +1,8 @@
 # 💻 Documentation and guides of ReVanced CLI
 
-This documentation explains how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
+This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli).
 
 ## 📖 Table of contents
 
 1. [💼 Prerequisites](0_prerequisites.md)
-2. [🛠️ Using the ReVanced CLI](1_usage.md)
+2. [🛠️ Using ReVanced CLI](1_usage.md)

gradle.properties

@@ -1,2 +1,4 @@
+org.gradle.parallel = true
+org.gradle.caching = true
 kotlin.code.style = official
-version = 2.20.2-dev.1
+version = 3.0.0-dev.6

gradle/libs.versions.toml

@@ -0,0 +1,25 @@
+[versions]
+shadow = "8.1.1"
+apksig = "8.1.0"
+bcpkix-jdk15on = "1.70"
+jackson-module-kotlin = "2.14.3"
+jadb = "2531a28109"
+kotlin-reflect = "1.9.0"
+kotlin-test = "1.8.20-RC"
+kotlinx-coroutines-core = "1.7.1"
+picocli = "4.7.3"
+revanced-patcher = "14.1.0"
+
+[libraries]
+apksig = { module = "com.android.tools.build:apksig", version.ref = "apksig" }
+bcpkix-jdk15on = { module = "org.bouncycastle:bcpkix-jdk15on", version.ref = "bcpkix-jdk15on" }
+jackson-module-kotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin", version.ref = "jackson-module-kotlin" }
+jadb = { module = "com.github.revanced:jadb", version.ref = "jadb" }
+kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin-reflect" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin-test" }
+kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines-core" }
+picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
+revanced-patcher = { module = "app.revanced:revanced-patcher", version.ref = "revanced-patcher" }
+
+[plugins]
+shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +41,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

settings.gradle.kts

@@ -1 +1,23 @@
+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/aligning/Aligning.kt

@@ -1,37 +0,0 @@
-package app.revanced.cli.aligning
-
-import app.revanced.cli.command.MainCommand.logger
-import app.revanced.patcher.PatcherResult
-import app.revanced.utils.signing.align.ZipAligner
-import app.revanced.utils.signing.align.zip.ZipFile
-import app.revanced.utils.signing.align.zip.structures.ZipEntry
-import java.io.File
-
-object Aligning {
-    fun align(result: PatcherResult, inputFile: File, outputFile: File) {
-        logger.info("Aligning ${inputFile.name} to ${outputFile.name}")
-
-        if (outputFile.exists()) outputFile.delete()
-
-        ZipFile(outputFile).use { file ->
-            result.dexFiles.forEach {
-                file.addEntryCompressData(
-                    ZipEntry.createWithName(it.name),
-                    it.stream.readBytes()
-                )
-            }
-
-            result.resourceFile?.let {
-                file.copyEntriesFromFileAligned(
-                    ZipFile(it),
-                    ZipAligner::getEntryAlignment
-                )
-            }
-
-            file.copyEntriesFromFileAligned(
-                ZipFile(inputFile),
-                ZipAligner::getEntryAlignment
-            )
-        }
-    }
-}

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

@@ -0,0 +1,91 @@
+package app.revanced.cli.command
+
+import app.revanced.patcher.PatchBundleLoader
+import app.revanced.patcher.annotation.Package
+import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
+import app.revanced.patcher.extensions.PatchExtensions.description
+import app.revanced.patcher.extensions.PatchExtensions.options
+import app.revanced.patcher.extensions.PatchExtensions.patchName
+import app.revanced.patcher.patch.PatchClass
+import app.revanced.patcher.patch.PatchOption
+import picocli.CommandLine.*
+import picocli.CommandLine.Help.Visibility.ALWAYS
+import java.io.File
+import java.util.logging.Logger
+
+
+@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..*"
+    )
+    private lateinit var patchBundles: Array<File>
+
+    @Option(
+        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"],
+        showDefaultValue = ALWAYS
+    )
+    private var withPackages: Boolean = false
+
+    @Option(
+        names = ["-v", "--with-versions"],
+        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
+    )
+    private var withOptions: Boolean = false
+
+    override fun run() {
+        fun Package.buildString() = buildString {
+            if (withVersions && versions.isNotEmpty()) {
+                appendLine("Package name: $name")
+                appendLine("Compatible versions:")
+                append(versions.joinToString("\n") { version -> version }.prependIndent("\t"))
+            } else append("Package name: $name")
+        }
+
+        fun PatchOption<*>.buildString() = buildString {
+            appendLine("Title: $title")
+            appendLine("Description: $description")
+
+            value?.let {
+                appendLine("Key: $key")
+                append("Value: $it")
+            } ?: append("Key: $key")
+        }
+
+        fun PatchClass.buildString() = buildString {
+            append("Name: $patchName")
+
+            if (withDescriptions) append("\nDescription: $description")
+
+            if (withOptions && options != null) {
+                appendLine("\nOptions:")
+                append(
+                    options!!.joinToString("\n\n") { option -> option.buildString() }.prependIndent("\t")
+                )
+            }
+
+            if (withPackages && compatiblePackages != null) {
+                appendLine("\nCompatible packages:")
+                append(
+                    compatiblePackages!!.joinToString("\n") { it.buildString() }.prependIndent("\t")
+                )
+            }
+        }
+
+        logger.info(PatchBundleLoader.Jar(*patchBundles).joinToString("\n\n") { it.buildString() })
+    }
+}

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

@@ -0,0 +1,46 @@
+package app.revanced.cli.command
+
+import app.revanced.patcher.PatchBundleLoader
+import app.revanced.utils.Options
+import app.revanced.utils.Options.setOptions
+import picocli.CommandLine
+import picocli.CommandLine.Help.Visibility.ALWAYS
+import java.io.File
+import java.util.logging.Logger
+
+@CommandLine.Command(
+    name = "options",
+    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..*"
+    )
+    private lateinit var patchBundles: Array<File>
+
+    @CommandLine.Option(
+        names = ["-p", "--path"], description = ["Path to patch options JSON file"], showDefaultValue = ALWAYS
+    )
+    private var path: File = File("options.json")
+
+    @CommandLine.Option(
+        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"],
+        showDefaultValue = ALWAYS
+    )
+    private var update: Boolean = false
+
+    override fun run() = if (!path.exists() || overwrite) with(PatchBundleLoader.Jar(*patchBundles)) {
+        if (update) setOptions(path)
+
+        Options.serialize(this, prettyPrint = true).let(path::writeText)
+    }
+    else logger.severe("Options file already exists, use --override to override it")
+}

src/main/kotlin/app/revanced/cli/command/utility/InstallCommand.kt

@@ -0,0 +1,42 @@
+package app.revanced.cli.command.utility
+
+import app.revanced.utils.adb.AdbManager
+import picocli.CommandLine.*
+import java.io.File
+import java.util.logging.Logger
+
+
+@Command(
+    name = "install", description = ["Install an APK file to devices with the supplied ADB device serials"]
+)
+internal object InstallCommand : Runnable {
+    private val logger = Logger.getLogger(InstallCommand::class.java.name)
+
+    @Parameters(
+        description = ["ADB device serials"], arity = "1..*"
+    )
+    private lateinit var deviceSerials: Array<String>
+
+    @Option(
+        names = ["-a", "--apk"], description = ["APK file to be installed"], required = true
+    )
+    private lateinit var apk: File
+
+    @Option(
+        names = ["-m", "--mount"],
+        description = ["Mount the supplied APK file over the app with the supplied package name"],
+    )
+    private var packageName: String? = null
+
+    override fun run() = try {
+        deviceSerials.forEach { deviceSerial ->
+            if (packageName != null) {
+                AdbManager.RootAdbManager(deviceSerial)
+            } else {
+                AdbManager.UserAdbManager(deviceSerial)
+            }.install(AdbManager.Apk(apk, packageName))
+        }
+    } catch (e: AdbManager.DeviceNotFoundException) {
+        logger.severe(e.toString())
+    }
+}

src/main/kotlin/app/revanced/cli/command/utility/UninstallCommand.kt

@@ -0,0 +1,40 @@
+package app.revanced.cli.command.utility
+
+import app.revanced.utils.adb.AdbManager
+import picocli.CommandLine.*
+import picocli.CommandLine.Help.Visibility.ALWAYS
+import java.util.logging.Logger
+
+
+@Command(
+    name = "uninstall",
+    description = ["Uninstall a patched app from the devices with the supplied ADB device serials"]
+)
+internal object UninstallCommand : Runnable {
+    private val logger = Logger.getLogger(UninstallCommand::class.java.name)
+
+    @Parameters(description = ["ADB device serials"], arity = "1..*")
+    private lateinit var deviceSerials: Array<String>
+
+    @Option(names = ["-p", "--package-name"], description = ["Package name of the app to uninstall"], required = true)
+    private lateinit var packageName: String
+
+    @Option(
+        names = ["-u", "--unmount"],
+        description = ["Uninstall by unmounting the patched APK file"],
+        showDefaultValue = ALWAYS
+    )
+    private var unmount: Boolean = false
+
+    override fun run() = try {
+        deviceSerials.forEach { deviceSerial ->
+            if (unmount) {
+                AdbManager.RootAdbManager(deviceSerial)
+            } else {
+                AdbManager.UserAdbManager(deviceSerial)
+            }.uninstall(packageName)
+        }
+    } catch (e: AdbManager.DeviceNotFoundException) {
+        logger.severe(e.toString())
+    }
+}

src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt

@@ -0,0 +1,10 @@
+package app.revanced.cli.command.utility
+
+import picocli.CommandLine
+
+@CommandLine.Command(
+    name = "utility",
+    description = ["Commands for utility purposes"],
+    subcommands = [InstallCommand::class, UninstallCommand::class],
+)
+internal object UtilityCommand

src/main/kotlin/app/revanced/cli/logging/CliLogger.kt

@@ -1,8 +0,0 @@
-package app.revanced.cli.logging
-
-internal interface CliLogger {
-     fun error(msg: String)
-     fun info(msg: String)
-     fun trace(msg: String)
-     fun warn(msg: String)
-}

src/main/kotlin/app/revanced/cli/logging/impl/DefaultCliLogger.kt

@@ -1,30 +0,0 @@
-package app.revanced.cli.logging.impl
-
-import app.revanced.cli.command.MainCommand
-import app.revanced.cli.logging.CliLogger
-import java.util.logging.Logger
-import java.util.logging.SimpleFormatter
-
-internal class DefaultCliLogger(
-    private val logger: Logger = Logger.getLogger(MainCommand::class.java.name),
-    private val errorLogger: Logger = Logger.getLogger(logger.name + "Err")
-) : CliLogger {
-
-    init {
-        logger.useParentHandlers = false
-        if (logger.handlers.isEmpty()) {
-            logger.addHandler(FlushingStreamHandler(System.out, SimpleFormatter()))
-        }
-    }
-
-    companion object {
-        init {
-            System.setProperty("java.util.logging.SimpleFormatter.format", "%4\$s: %5\$s %n")
-        }
-    }
-
-    override fun error(msg: String) = errorLogger.severe(msg)
-    override fun info(msg: String) = logger.info(msg)
-    override fun trace(msg: String) = logger.finest(msg)
-    override fun warn(msg: String) = errorLogger.warning(msg)
-}

src/main/kotlin/app/revanced/cli/logging/impl/FlushingStreamHandler.kt

@@ -1,13 +0,0 @@
-package app.revanced.cli.logging.impl
-
-import java.io.OutputStream
-import java.util.logging.Formatter
-import java.util.logging.LogRecord
-import java.util.logging.StreamHandler
-
-internal class FlushingStreamHandler(out: OutputStream, format: Formatter) : StreamHandler(out, format) {
-    override fun publish(record: LogRecord) {
-        super.publish(record)
-        flush()
-    }
-}

src/main/kotlin/app/revanced/cli/main/Main.kt

@@ -1,8 +0,0 @@
-package app.revanced.cli.main
-
-import app.revanced.cli.command.MainCommand
-import picocli.CommandLine
-
-internal fun main(args: Array<String>) {
-    CommandLine(MainCommand).execute(*args)
-}

src/main/kotlin/app/revanced/cli/patcher/Patcher.kt

@@ -1,24 +0,0 @@
-package app.revanced.cli.patcher
-
-import app.revanced.patcher.PatcherResult
-import app.revanced.patcher.data.Context
-import app.revanced.patcher.patch.Patch
-import app.revanced.utils.patcher.addPatchesFiltered
-import app.revanced.utils.patcher.applyPatchesVerbose
-import app.revanced.utils.patcher.mergeFiles
-
-internal object Patcher {
-    internal fun start(
-        patcher: app.revanced.patcher.Patcher,
-        allPatches: List<Class<out Patch<Context>>>
-    ): PatcherResult {
-        // merge files like necessary integrations
-        patcher.mergeFiles()
-        // add patches, but filter incompatible or excluded patches
-        patcher.addPatchesFiltered(allPatches)
-        // apply patches
-        patcher.applyPatchesVerbose()
-
-        return patcher.save()
-    }
-}

src/main/kotlin/app/revanced/cli/patcher/logging/impl/PatcherLogger.kt

@@ -1,13 +0,0 @@
-package app.revanced.cli.patcher.logging.impl
-
-import app.revanced.cli.logging.impl.DefaultCliLogger
-import java.util.logging.Logger
-
-internal object PatcherLogger : app.revanced.patcher.logging.Logger{
-    private val logger = DefaultCliLogger(Logger.getLogger(app.revanced.patcher.Patcher::class.java.name))
-
-    override fun error(msg: String) = logger.error(msg)
-    override fun info(msg: String) = logger.info(msg)
-    override fun warn(msg: String)= logger.warn(msg)
-    override fun trace(msg: String)= logger.trace(msg)
-}