build(deps): bump kotlin from 1.9.22 to 1.9.23

Bumps `kotlin` from 1.9.22 to 1.9.23.

Updates `org.jetbrains.kotlin:kotlin-test` from 1.9.22 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.22...v1.9.23)

Updates `org.jetbrains.kotlin.jvm` from 1.9.22 to 1.9.23
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.9.23/ChangeLog.md)
- [Commits](https://github.com/JetBrains/kotlin/compare/v1.9.22...v1.9.23)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin:kotlin-test
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: org.jetbrains.kotlin.jvm
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

.editorconfig

@@ -0,0 +1,3 @@
+[*.{kt,kts}]
+ktlint_code_style = intellij_idea
+ktlint_standard_no-wildcard-imports = disabled

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: gradle
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly

.github/workflows/build_pull_request.yml

@@ -0,0 +1,25 @@
+name: Build pull request
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - dev
+
+jobs:
+  release:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Cache Gradle
+        uses: burrunan/gradle-cache-action@v1
+
+      - name: Build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./gradlew build --no-daemon

.github/workflows/release.yml

@@ -6,10 +6,6 @@ on:
     branches:
       - main
       - dev
-  pull_request:
-    branches:
-      - main
-      - dev
 
 jobs:
   release:
@@ -24,25 +20,30 @@ jobs:
           persist-credentials: false
           fetch-depth: 0
 
-      - name: Cache Node modules
-        uses: actions/cache@v3
-        with:
-          path: |
-            node_modules
-          key: npm-${{ hashFiles('package-lock.json') }}
-
       - name: Cache Gradle
         uses: burrunan/gradle-cache-action@v1
 
       - 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
+        run: ./gradlew build clean
 
-      - name: Setup semantic-release
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: 'npm'
+
+      - name: Install dependencies
         run: npm install
 
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          fingerprint: ${{ env.GPG_FINGERPRINT }}
+
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}

.github/workflows/update_documentation.yml

@@ -11,7 +11,7 @@ jobs:
     name: Dispatch event to documentation repository
     if: github.ref == 'refs/heads/main'
     steps:
-      - uses: peter-evans/repository-dispatch@v2
+      - uses: peter-evans/repository-dispatch@v3
         with:
           token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
           repository: revanced/revanced-documentation

.gitignore

@@ -119,4 +119,7 @@ node_modules/
 
 # ReVanced CLI
 revanced-cache/
-options.toml
+options.toml
+
+# Generated by an Android project (such as ReVanced Integrations)
+local.properties

.releaserc

@@ -31,7 +31,7 @@
       {
         "assets": [
           {
-            "path": "build/libs/*all.jar"
+            "path": "build/libs/*-all*"
           }
         ],
         successComment: false

CHANGELOG.md

@@ -1,3 +1,95 @@
+# [4.6.0](https://github.com/ReVanced/revanced-cli/compare/v4.5.0...v4.6.0) (2024-04-01)
+
+
+### Bug Fixes
+
+* Copy APK to output path when it is not being signed ([366f400](https://github.com/ReVanced/revanced-cli/commit/366f400c5a46491f3f262c7ff4b0df1ae3721f74))
+* Use correct option description ([45a2ffa](https://github.com/ReVanced/revanced-cli/commit/45a2ffa2dd95ee8ac3c4d466463c9a5b869b8da1))
+
+
+### Features
+
+* Use more consistent option name ([223629c](https://github.com/ReVanced/revanced-cli/commit/223629c663dcd94d237110e09e4e152aa03867f9))
+
+# [4.6.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.5.1-dev.1...v4.6.0-dev.1) (2024-03-14)
+
+
+### Bug Fixes
+
+* Use correct option description ([45a2ffa](https://github.com/ReVanced/revanced-cli/commit/45a2ffa2dd95ee8ac3c4d466463c9a5b869b8da1))
+
+
+### Features
+
+* Use more consistent option name ([223629c](https://github.com/ReVanced/revanced-cli/commit/223629c663dcd94d237110e09e4e152aa03867f9))
+
+## [4.5.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.5.0...v4.5.1-dev.1) (2024-03-12)
+
+
+### Bug Fixes
+
+* Copy APK to output path when it is not being signed ([366f400](https://github.com/ReVanced/revanced-cli/commit/366f400c5a46491f3f262c7ff4b0df1ae3721f74))
+
+# [4.5.0](https://github.com/ReVanced/revanced-cli/compare/v4.4.2...v4.5.0) (2024-03-11)
+
+
+### Bug Fixes
+
+* Show path for missing files instead of just the name ([f0f3e56](https://github.com/ReVanced/revanced-cli/commit/f0f3e5614b99b34391e0492177706f9c09781cad))
+* Sign APKs correctly ([5ff105c](https://github.com/ReVanced/revanced-cli/commit/5ff105cf6b3fac9cd12478efd10caf90d1ecf589))
+
+
+### Features
+
+* Remove deprecated CLI options ([48a1a39](https://github.com/ReVanced/revanced-cli/commit/48a1a39b94dd9121c400d28e3e93dec3fc13e3be))
+
+# [4.5.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.4.2...v4.5.0-dev.1) (2024-03-11)
+
+
+### Bug Fixes
+
+* Show path for missing files instead of just the name ([f0f3e56](https://github.com/ReVanced/revanced-cli/commit/f0f3e5614b99b34391e0492177706f9c09781cad))
+* Sign APKs correctly ([5ff105c](https://github.com/ReVanced/revanced-cli/commit/5ff105cf6b3fac9cd12478efd10caf90d1ecf589))
+
+
+### Features
+
+* Remove deprecated CLI options ([48a1a39](https://github.com/ReVanced/revanced-cli/commit/48a1a39b94dd9121c400d28e3e93dec3fc13e3be))
+
+## [4.4.2](https://github.com/ReVanced/revanced-cli/compare/v4.4.1...v4.4.2) (2024-03-10)
+
+## [4.4.2-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.4.2-dev.1...v4.4.2-dev.2) (2024-03-10)
+
+## [4.4.2-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.4.1...v4.4.2-dev.1) (2024-03-09)
+
+## [4.4.1](https://github.com/ReVanced/revanced-cli/compare/v4.4.0...v4.4.1) (2024-03-06)
+
+
+### Bug Fixes
+
+* Bump dependencies to support BCS keystore ([1c10a77](https://github.com/ReVanced/revanced-cli/commit/1c10a7760d76ea850260ca49b448be7ad121de44))
+
+## [4.4.1-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.4.1-dev.1...v4.4.1-dev.2) (2024-03-04)
+
+
+### Bug Fixes
+
+* Bump dependencies to support BCS keystore ([1c10a77](https://github.com/ReVanced/revanced-cli/commit/1c10a7760d76ea850260ca49b448be7ad121de44))
+
+## [4.4.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.4.0...v4.4.1-dev.1) (2024-02-21)
+
+# [4.4.0](https://github.com/ReVanced/revanced-cli/compare/v4.3.0...v4.4.0) (2023-12-28)
+
+
+### Bug Fixes
+
+* Add missing punctuation in command description ([8210351](https://github.com/ReVanced/revanced-cli/commit/821035107d7264580275f395e9e3fcef91394afd))
+
+
+### Features
+
+* Log saved patched APK file path ([16109bd](https://github.com/ReVanced/revanced-cli/commit/16109bd8bc6236debf71cbc8db78fe452b2ed00d))
+
 # [4.4.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.4.0-dev.1...v4.4.0-dev.2) (2023-12-18)
 
 

CONTRIBUTING.md

@@ -64,14 +64,14 @@ This document describes how to contribute to ReVanced CLI.
 
 ## 📖 Resources to help you get started
 
-* The [documentation](/docs) explains how to use ReVanced CLI
-* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
-* [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests
+- The [documentation](/docs) explains how to use ReVanced CLI
+- [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
+- [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests
 
 ## 🙏 Submitting a feature request
 
 Features can be requested by opening an issue using the
-[Feature request issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Feature+request&projects=&template=feature-request.yml&title=feat%3A+).
+[Feature request issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+).
 
 > **Note**
 > Requests can be accepted or rejected at the discretion of maintainers of ReVanced CLI.
@@ -80,7 +80,7 @@ Features can be requested by opening an issue using the
 ## 🐞 Submitting a bug report
 
 If you encounter a bug while using ReVanced CLI, open an issue using the
-[Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug-report.yml&title=bug%3A+).
+[Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).
 
 ## 📝 How to contribute
 
@@ -88,11 +88,11 @@ If you encounter a bug while using ReVanced CLI, open an issue using the
    with the maintainers of ReVanced CLI. This will help you determine whether your change is acceptable
    and whether it is worth your time to implement it
 2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev`
-3. Commit your changes.
+3. Commit your changes
 4. Submit a pull request to the `dev` branch of the repository and reference issues
    that your pull request closes in the description of your pull request
 5. Our team will review your pull request and provide feedback. Once your pull request is approved,
    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,
+❤️ Thank you for considering contributing to ReVanced CLI,  
 ReVanced

README.md

@@ -67,13 +67,23 @@ Command line application to use ReVanced.
 
 ## ❓ About
 
-ReVanced CLI is a command line application to patch apps using ReVanced.
-ReVanced CLI also comes with commands to uninstall or install patched apps and list patches from supplied patch bundles.
+ReVanced CLI is a command line application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.
 
-## 🚀 Download
+## 💪 Features
 
-You can download the most recent version of ReVanced CLI from 
-[here](https://github.com/ReVanced/revanced-cli/releases/latest). Learn how to use ReVanced CLI by following the [documentation](/docs).
+Some of the features ReVanced CLI provides are:
+
+- 💉 **Patch apps**: Harness ReVanced Patcher to patch Android apps
+- 💾 **Install and uninstall apps**: Install and uninstall Apps via ADB,
+  using the Android package manager, or by mounting using root permissions
+- 📃 **List patches from patch bundles**: List available patches, compatible packages, and versions
+- 💪 **Flexibility and functionality**: Apply any combination of patches to any version of Android apps
+
+## 🔽 Download
+
+You can download the most recent version of ReVanced CLI from
+[here](https://github.com/ReVanced/revanced-cli/releases/latest).  
+Learn how to use ReVanced CLI by following the [documentation](/docs).
 
 ## 📚 Everything else
 
@@ -84,10 +94,14 @@ You can find the contribution guidelines [here](CONTRIBUTING.md).
 
 ### 🛠️ Building
 
-In order to build ReVanced CLI, you can follow the [documentation](/docs).
+To build a ReVanced CLI, you can follow the [documentation](/docs).
+
+### 📃 Documentation
+
+You can find the documentation of ReVanced CLI [here](/docs).
 
 ## 📜 Licence
 
-ReVanced CLI is licensed under the GPLv3 licence. Please see the [licence file](LICENSE) for more information.
+ReVanced CLI is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
 [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced CLI as long as you track changes/dates in source files.
-Any modifications to ReVanced CLI must also be made available under the GPL along with build & install instructions.
+Any modifications to ReVanced CLI must also be made available under the GPL, along with build & install instructions.

build.gradle.kts

@@ -1,15 +1,31 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
-    kotlin("jvm") version "1.9.10"
+    alias(libs.plugins.kotlin)
     alias(libs.plugins.shadow)
+    application
+    `maven-publish`
+    signing
 }
 
 group = "app.revanced"
 
+application {
+    mainClass = "app.revanced.cli.command.MainCommandKt"
+}
+
 repositories {
     mavenCentral()
     mavenLocal()
     google()
-    maven { url = uri("https://jitpack.io") }
+    maven {
+        // A repository must be speficied for some reason. "registry" is a dummy.
+        url = uri("https://maven.pkg.github.com/revanced/registry")
+        credentials {
+            username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
+            password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
+        }
+    }
 }
 
 dependencies {
@@ -21,7 +37,15 @@ dependencies {
     testImplementation(libs.kotlin.test)
 }
 
-kotlin { jvmToolchain(11) }
+kotlin {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
+    }
+}
+
+java {
+    targetCompatibility = JavaVersion.VERSION_11
+}
 
 tasks {
     test {
@@ -36,9 +60,6 @@ tasks {
     }
 
     shadowJar {
-        manifest {
-            attributes("Main-Class" to "app.revanced.cli.command.MainCommandKt")
-        }
         minimize {
             exclude(dependency("org.jetbrains.kotlin:.*"))
             exclude(dependency("org.bouncycastle:.*"))
@@ -46,25 +67,29 @@ tasks {
         }
     }
 
-    build {
+    publish {
         dependsOn(shadowJar)
     }
+}
 
-    /*
-    Dummy task to hack gradle-semantic-release-plugin to release this project.
+// Needed by gradle-semantic-release-plugin.
+// Tracking: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
 
-    Explanation:
-    SemVer is a standard for versioning libraries.
-    For that reason the semantic-release plugin uses the "publish" task to publish libraries.
-    However, this subproject is not a library, and the "publish" task is not available for this subproject.
-    Because semantic-release is not designed to handle this case, we need to hack it.
+// The maven-publish is also necessary to make the signing plugin work.
+publishing {
+    repositories {
+        mavenLocal()
+    }
 
-    RE: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
-     */
-
-    register<DefaultTask>("publish") {
-        group = "publishing"
-        description = "Dummy task to hack gradle-semantic-release-plugin to release ReVanced CLI"
-        dependsOn(build)
+    publications {
+        create<MavenPublication>("revanced-cli-publication") {
+            from(components["java"])
+        }
     }
 }
+
+signing {
+    useGpgCmd()
+
+    sign(publishing.publications["revanced-cli-publication"])
+}

docs/0_prerequisites.md

@@ -4,8 +4,8 @@ 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
+- Java Runtime Environment 11 ([Azul Zulu JRE](https://www.azul.com/downloads/?version=java-11-lts&package=jdk#zulu) or [OpenJDK](https://jdk.java.net/archive/))
+- [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)
 
 ## ⏭️ Whats next

docs/1_usage.md

@@ -1,6 +1,6 @@
 # 🛠️ Using ReVanced CLI
 
-Learn how to ReVanced CLI.
+Learn how to use ReVanced CLI.
 
 ## 🔨 Usage
 
@@ -26,7 +26,7 @@ ReVanced CLI is divided into the following fundamental commands:
 
   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 \
@@ -34,71 +34,50 @@ ReVanced CLI is divided into the following fundamental commands:
    revanced-patches.jar [<patch-bundle> ...]
   ```
 
-> [!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.
+  > **ℹ️ 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.
 
 - ### 💉 Patch an app
 
   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:
 
-> [!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
-> ```
->
+  > **💡 Tip**  
+  > For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working:
+  >
+  > ```bash
+  > adb shell exit
+  > ```
+  >
+  > 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
+  > ```
 
-> [!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.
+  > **⚠️ 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.
 
   - #### 👾 Patch an app and install it on your device regularly
 
     ```bash
     java -jar revanced-cli.jar patch \
      --patch-bundle revanced-patches.jar \
-     --device-serial <device-serial> \
+     -d \
      input.apk
     ```
 
   - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions
-  
-  > [!IMPORTANT]  
-  > Ensure that the same app you are patching and mounting over is installed on your device:
-  > 
-  > ```bash
-  > adb install app.apk
-  > ```
 
-  > [!NOTE]  
-  > You can use the option `--ii` to include or `--ie` to exclude
-  > patches by their index in relation to supplied patch bundles,
-  > similarly to the option `--include` and `--exclude`.
-  > 
-  > This is useful in case two patches have the same name, and you must include or exclude one.  
-  > The patch index is calculated by the position of the patch in the list of patches
-  > from patch bundles supplied using the option `--patch-bundle`.
-  > 
-  > You can list all patches with their indices using the command `list-patches`.
-  > 
-  > Keep in mind that the indices can change based on the order of the patch bundles supplied,
-  > as well if the patch bundles are updated because patches can be added or removed.
+    > **❗ Caution**  
+    > Ensure that 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 \
@@ -106,11 +85,25 @@ without any need for intervention when using the `patch` command.
      --include "Some patch" \
      --ii 123 \
      --exclude "Some other patch" \
-     --device-serial <device-serial> \
+     -d \
      --mount \
      app.apk
     ```
 
+    > **💡 Tip**  
+    > You can use the option `--ii` to include or `--ie` to exclude
+    > patches by their index in relation to supplied patch bundles,
+    > similarly to the option `--include` and `--exclude`.
+    >
+    > This is useful in case two patches have the same name, and you must include or exclude one.  
+    > The patch index is calculated by the position of the patch in the list of patches
+    > from patch bundles supplied using the option `--patch-bundle`.
+    >
+    > You can list all patches with their indices using the command `list-patches`.
+    >
+    > Keep in mind that the indices can change based on the order of the patch bundles supplied,
+    > as well if the patch bundles are updated because patches can be added or removed.
+
 - ### 🗑️ Uninstall an app
 
   ```bash
@@ -119,9 +112,9 @@ without any need for intervention when using the `patch` command.
    [<device-serial>]
   ```
 
-> [!NOTE]  
-> You can unmount an APK file
-by adding the option `--unmount`.
+  > **💡 Tip**  
+  > You can unmount an APK file
+  > by adding the option `--unmount`.
 
 - ### ️ 📦 Install an app
 
@@ -131,6 +124,6 @@ by adding the option `--unmount`.
    [<device-serial>]
   ```
 
-> [!NOTE]  
-> You can mount an APK file 
-> by supplying the package name of the app to mount the supplied APK file over the option `--mount`.
+  > **💡 Tip**  
+  > You can mount an APK file
+  > by supplying the app's package name to mount the supplied APK file over the option `-mount`.

docs/2_building.md

@@ -0,0 +1,37 @@
+# 🔨️ Building
+
+Build ReVanced CLI from source.
+
+## 📝 Requirements
+
+- Java Development Kit 11 (Azul Zulu JRE or OpenJDK)
+
+## 🏗️ Building
+
+To build ReVanced CLI, follow these steps:
+
+1. Clone the repository:
+
+   ```bash
+   git clone git@github.com:ReVanced/revanced-cli.git
+   cd revanced-cli
+   ```
+
+2. Build the project:
+
+   ```bash
+    ./gradlew build
+   ```
+
+> [!NOTE]
+> If the build fails due to authentication, you may need to authenticate to GitHub Packages.
+> Create a PAT with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) and add your token to ~/.gradle/gradle.properties.
+>
+> Example `gradle.properties` file:
+>
+> ```properties
+> gpr.user = user
+> gpr.key = key
+> ```
+
+After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli-<version>-all.jar`.

docs/README.md

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

gradle.properties

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

gradle/libs.versions.toml

@@ -1,13 +1,13 @@
 [versions]
 shadow = "8.1.1"
-kotlin-test = "1.9.20"
+kotlin = "1.9.23"
 kotlinx-coroutines-core = "1.7.3"
-picocli = "4.7.3"
-revanced-patcher = "19.1.0"
-revanced-library = "1.4.0"
+picocli = "4.7.5"
+revanced-patcher = "19.3.1"
+revanced-library = "2.3.0"
 
 [libraries]
-kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin-test" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
 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" }
@@ -15,3 +15,4 @@ revanced-library = { module = "app.revanced:revanced-library", version.ref = "re
 
 [plugins]
 shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" }
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
-distributionSha256Sum=3e1af3ae886920c3ac87f7a91f816c0c7c436f276a6eefdb3da152100fef72ae
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
+distributionSha256Sum=9631d53cf3e74bfa726893aee1f8994fee4e060c401335946dba2156f440f24c
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dist

package.json

@@ -1,9 +1,9 @@
 {
   "devDependencies": {
-    "@saithodev/semantic-release-backmerge": "^3.2.1",
+    "@saithodev/semantic-release-backmerge": "^4.0.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "gradle-semantic-release-plugin": "^1.8.0",
-    "semantic-release": "^22.0.8"
+    "gradle-semantic-release-plugin": "^1.9.1",
+    "semantic-release": "^23.0.2"
   }
 }

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

@@ -1,13 +1,14 @@
 package app.revanced.cli.command
 
 import app.revanced.library.ApkUtils
+import app.revanced.library.ApkUtils.applyTo
 import app.revanced.library.Options
 import app.revanced.library.Options.setOptions
 import app.revanced.library.adb.AdbManager
 import app.revanced.patcher.PatchBundleLoader
 import app.revanced.patcher.PatchSet
 import app.revanced.patcher.Patcher
-import app.revanced.patcher.PatcherOptions
+import app.revanced.patcher.PatcherConfig
 import kotlinx.coroutines.runBlocking
 import picocli.CommandLine
 import picocli.CommandLine.Help.Visibility.ALWAYS
@@ -30,9 +31,9 @@ internal object PatchCommand : Runnable {
 
     private lateinit var apk: File
 
-    private var integrations = listOf<File>()
+    private var integrations = setOf<File>()
 
-    private var patchBundles = emptyList<File>()
+    private var patchBundles = emptySet<File>()
 
     @CommandLine.Option(
         names = ["-i", "--include"],
@@ -84,6 +85,7 @@ internal object PatchCommand : Runnable {
         names = ["-o", "--out"],
         description = ["Path to save the patched APK file to. Defaults to the same directory as the supplied APK file."],
     )
+    @Suppress("unused")
     private fun setOutputFilePath(outputFilePath: File?) {
         this.outputFilePath = outputFilePath?.absoluteFile
     }
@@ -91,7 +93,8 @@ internal object PatchCommand : Runnable {
     @CommandLine.Option(
         names = ["-d", "--device-serial"],
         description = ["ADB device serial to install to. If not supplied, the first connected device will be used."],
-        fallbackValue = "", // Empty string to indicate that the first connected device should be used.
+        // Empty string to indicate that the first connected device should be used.
+        fallbackValue = "",
         arity = "0..1",
     )
     private var deviceSerial: String? = null
@@ -112,7 +115,6 @@ internal object PatchCommand : Runnable {
     )
     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. Empty password by default."],
@@ -121,16 +123,26 @@ internal object PatchCommand : Runnable {
 
     @CommandLine.Option(
         names = ["--alias"],
-        description = ["The alias of the key from the keystore to sign the patched APK file with."],
+        description = ["The alias of the keystore entry to sign the patched APK file with."],
         showDefaultValue = ALWAYS,
     )
-    private var alias = "ReVanced Key"
+    private fun setKeyStoreEntryAlias(alias: String = "ReVanced Key") {
+        logger.warning("The --alias option is deprecated. Use --keystore-entry-alias instead.")
+        keyStoreEntryAlias = alias
+    }
+
+    @CommandLine.Option(
+        names = ["--keystore-entry-alias"],
+        description = ["The alias of the keystore entry to sign the patched APK file with."],
+        showDefaultValue = ALWAYS,
+    )
+    private var keyStoreEntryAlias = "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."],
     )
-    private var password = "" // Empty password by default
+    private var keyStoreEntryPassword = "" // Empty password by default
 
     @CommandLine.Option(
         names = ["--signer"],
@@ -140,10 +152,10 @@ internal object PatchCommand : Runnable {
     private var signer = "ReVanced"
 
     @CommandLine.Option(
-        names = ["-r", "--resource-cache"],
-        description = ["Path to temporary resource cache directory."],
+        names = ["-t", "--temporary-files-path"],
+        description = ["Path to temporary files directory."],
     )
-    private var resourceCachePath: File? = null
+    private var temporaryFilesPath: File? = null
 
     private var aaptBinaryPath: File? = null
 
@@ -170,7 +182,7 @@ internal object PatchCommand : Runnable {
         if (!apk.exists()) {
             throw CommandLine.ParameterException(
                 spec.commandLine(),
-                "APK file ${apk.name} does not exist",
+                "APK file ${apk.path} does not exist",
             )
         }
         this.apk = apk
@@ -183,7 +195,7 @@ internal object PatchCommand : Runnable {
     @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.path} does not exist.")
         }
         this.integrations += integrations
     }
@@ -194,11 +206,11 @@ internal object PatchCommand : Runnable {
         required = true,
     )
     @Suppress("unused")
-    private fun setPatchBundles(patchBundles: Array<File>) {
+    private fun setPatchBundles(patchBundles: Set<File>) {
         patchBundles.firstOrNull { !it.exists() }?.let {
             throw CommandLine.ParameterException(spec.commandLine(), "Patch bundle ${it.name} does not exist")
         }
-        this.patchBundles = patchBundles.toList()
+        this.patchBundles = patchBundles
     }
 
     @CommandLine.Option(
@@ -224,9 +236,9 @@ internal object PatchCommand : Runnable {
                 "${apk.nameWithoutExtension}-patched.${apk.extension}",
             )
 
-        val resourceCachePath =
-            resourceCachePath ?: outputFilePath.parentFile.resolve(
-                "${outputFilePath.nameWithoutExtension}-resource-cache",
+        val temporaryFilesPath =
+            temporaryFilesPath ?: outputFilePath.parentFile.resolve(
+                "${outputFilePath.nameWithoutExtension}-temporary-files",
             )
 
         val optionsFile =
@@ -259,13 +271,13 @@ internal object PatchCommand : Runnable {
         }
 
         // endregion
-
-        Patcher(
-            PatcherOptions(
+        val patcherTemporaryFilesPath = temporaryFilesPath.resolve("patcher")
+        val (packageName, patcherResult) = Patcher(
+            PatcherConfig(
                 apk,
-                resourceCachePath,
+                patcherTemporaryFilesPath,
                 aaptBinaryPath?.path,
-                resourceCachePath.absolutePath,
+                patcherTemporaryFilesPath.absolutePath,
                 true,
             ),
         ).use { patcher ->
@@ -282,65 +294,61 @@ internal object PatchCommand : Runnable {
 
             // region Patch
 
-            val patcherResult =
-                patcher.apply {
-                    acceptIntegrations(integrations)
-                    acceptPatches(filteredPatches.toList())
+            patcher.context.packageMetadata.packageName to patcher.apply {
+                acceptIntegrations(integrations)
+                acceptPatches(filteredPatches)
 
-                    // Execute patches.
-                    runBlocking {
-                        apply(false).collect { patchResult ->
-                            patchResult.exception?.let {
-                                StringWriter().use { writer ->
-                                    it.printStackTrace(PrintWriter(writer))
-                                    logger.severe("${patchResult.patch.name} failed:\n$writer")
-                                }
-                            } ?: logger.info("${patchResult.patch.name} succeeded")
-                        }
+                // Execute patches.
+                runBlocking {
+                    apply(false).collect { patchResult ->
+                        patchResult.exception?.let {
+                            StringWriter().use { writer ->
+                                it.printStackTrace(PrintWriter(writer))
+                                logger.severe("${patchResult.patch.name} failed:\n$writer")
+                            }
+                        } ?: logger.info("${patchResult.patch.name} succeeded")
                     }
-                }.get()
-
-            // endregion
-
-            // region Save
-
-            val alignedFile =
-                resourceCachePath.resolve(apk.name).apply {
-                    ApkUtils.copyAligned(apk, this, patcherResult)
                 }
-
-            if (!mount) {
-                ApkUtils.sign(
-                    alignedFile,
-                    outputFilePath,
-                    ApkUtils.SigningOptions(
-                        keystoreFilePath,
-                        keyStorePassword,
-                        alias,
-                        password,
-                        signer,
-                    ),
-                )
-            } else {
-                alignedFile.renameTo(outputFilePath)
-            }
-
-            logger.info("Saved to $outputFilePath")
-
-            // endregion
-
-            // region Install
-
-            deviceSerial?.let { serial ->
-                AdbManager.getAdbManager(deviceSerial = serial.ifEmpty { null }, mount)
-            }?.install(AdbManager.Apk(outputFilePath, patcher.context.packageMetadata.packageName))
-
+            }.get()
             // endregion
         }
 
+        // region Save
+        apk.copyTo(temporaryFilesPath.resolve(apk.name), overwrite = true).apply {
+            patcherResult.applyTo(this)
+        }.let { patchedApkFile ->
+            if (!mount) {
+                ApkUtils.signApk(
+                    patchedApkFile,
+                    outputFilePath,
+                    signer,
+                    ApkUtils.KeyStoreDetails(
+                        keystoreFilePath,
+                        keyStorePassword,
+                        keyStoreEntryAlias,
+                        keyStoreEntryPassword,
+                    ),
+                )
+            } else {
+                patchedApkFile.copyTo(outputFilePath, overwrite = true)
+            }
+        }
+
+        logger.info("Saved to $outputFilePath")
+
+        // endregion
+
+        // region Install
+
+        deviceSerial?.let { serial ->
+            AdbManager.getAdbManager(deviceSerial = serial.ifEmpty { null }, mount)
+        }?.install(AdbManager.Apk(outputFilePath, packageName))
+
+        // endregion
+
         if (purge) {
             logger.info("Purging temporary files")
-            purge(resourceCachePath)
+            purge(temporaryFilesPath)
         }
     }