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

# [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](a9c2a5f096))
* use correct option name ([f8972ea](f8972eac3e))

* refactor!: restructure code ([07da528](07da528ce2))

### Features

* add options command ([9edbbf3](9edbbf3163))
* use better logging text ([b0e748d](b0e748daff))
* use separate command to list patches ([b74213f](b74213f66e))
* use separate command to patch ([32da961](32da961d57))
* use separate command to uninstall ([c0cc909](c0cc909626))
* use simpler log ([ba758f0](ba758f00f4))

### BREAKING CHANGES

* This introduces major changes to how ReVanced CLI is used from the command line.

.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/pull_request.yml

@@ -0,0 +1,25 @@
+name: PR to main
+
+on:
+  push:
+    branches:
+      - dev
+  workflow_dispatch:
+
+env:
+  MESSAGE: merge branch `${{ github.head_ref || github.ref_name }}` to `main`
+
+jobs:
+  pull-request:
+    name: Open pull request
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Open pull request
+        uses: repo-sync/pull-request@v2
+        with:
+          destination_branch: 'main'
+          pr_title: 'chore: ${{ env.MESSAGE }}'
+          pr_body: 'This pull request will ${{ env.MESSAGE }}.'
+          pr_draft: true

.github/workflows/release.yml

@@ -1,4 +1,5 @@
 name: Release
+
 on:
   workflow_dispatch:
   push:
@@ -9,6 +10,7 @@ on:
     branches:
       - main
       - dev
+
 jobs:
   release:
     name: Release
@@ -17,24 +19,27 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
         with:
+          # Make sure the release step uses its own credentials:
+          # 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: 'temurin'
-          cache: gradle
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "lts/*"
+          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 with Gradle
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: ./gradlew build clean
+        run: ./gradlew clean --no-daemon
       - name: Setup semantic-release
-        run: npm install -g semantic-release @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D
+        run: npm install
       - name: Release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+          GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
+        run: npm exec semantic-release

.github/workflows/update-documentation.yml

@@ -0,0 +1,19 @@
+name: Update documentation
+
+on:
+  push:
+    paths:
+      - docs/**
+
+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:
+          token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
+          repository: revanced/revanced-documentation
+          event-type: update-documentation
+          client-payload: '{"repo": "${{ github.event.repository.name }}", "ref": "${{ github.ref }}"}'

.gitignore

@@ -74,6 +74,7 @@ cmake-build-*/
 
 # IntelliJ
 out/
+.idea
 
 # mpeltonen/sbt-idea plugin
 .idea_modules/
@@ -113,6 +114,9 @@ gradle-app.setting
 # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
 # gradle/wrapper/gradle-wrapper.properties
 
+# Dependency directories
+node_modules/
+
+# ReVanced CLI
 revanced-cache/
-options.toml
-.idea/vcs.xml
+options.toml

.idea/.gitignore

@@ -1,9 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
-/kotlinc.xml

.idea/discord.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="DiscordProjectSettings">
-    <option name="show" value="PROJECT_FILES" />
-    <option name="description" value="" />
-  </component>
-</project>

.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

.idea/misc.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="FrameworkDetectionExcludesConfiguration">
-    <file type="web" url="file://$PROJECT_DIR$" />
-  </component>
-  <component name="PWA">
-    <option name="enabled" value="true" />
-    <option name="wasEnabledAtLeastOnce" value="true" />
-  </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="azul-17" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

.idea/vcs.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CommitMessageInspectionProfile">
-    <profile version="1.0">
-      <inspection_tool class="CommitFormat" enabled="true" level="WARNING" enabled_by_default="true" />
-      <inspection_tool class="CommitNamingConvention" enabled="true" level="WARNING" enabled_by_default="true" />
-    </profile>
-  </component>
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.releaserc

@@ -7,11 +7,13 @@
     }
   ],
   "plugins": [
-    ["@semantic-release/commit-analyzer", {
-      "releaseRules": [
-        {"type": "build", "release": "patch"}
-      ]
-    }],
+    [
+      "@semantic-release/commit-analyzer", {
+        "releaseRules": [
+          { "type": "build", "scope": "Needs bump", "release": "patch" }
+        ]
+      }
+    ],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
     "gradle-semantic-release-plugin",
@@ -31,7 +33,15 @@
           {
             "path": "build/libs/*all.jar"
           }
-        ]
+        ],
+        successComment: false
+      }
+    ],
+    [
+      "@saithodev/semantic-release-backmerge",
+      {
+        backmergeBranches: [{"from": "main", "to": "dev"}],
+        clearWorkspace: true
       }
     ]
   ]

README.md

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

build.gradle.kts

@@ -1,55 +1,56 @@
 plugins {
-    kotlin("jvm") version "1.7.0"
-    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(kotlin("reflect"))
-
-    implementation("app.revanced:revanced-patcher:6.1.0")
-    implementation("info.picocli:picocli:4.7.0")
-    implementation("com.android.tools.build:apksig:7.2.1")
-    implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork
-    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 {
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events("PASSED", "SKIPPED", "FAILED")
+        }
+    }
+
+    processResources {
+        expand("projectVersion" to project.version)
+    }
+
     build {
         dependsOn(shadowJar)
     }
+
     shadowJar {
         manifest {
             attributes("Main-Class" to "app.revanced.cli.main.MainKt")
-            attributes("Implementation-Title" to project.name)
-            attributes("Implementation-Version" to project.version)
+        }
+        minimize {
+            exclude(dependency("org.jetbrains.kotlin:.*"))
+            exclude(dependency("org.bouncycastle:.*"))
+            exclude(dependency("app.revanced:.*"))
         }
     }
+
     // 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
     register<DefaultTask>("publish") {
         group = "publish"
         description = "Dummy task"
-        dependsOn(build)
     }
 }

docs/0_prerequisites.md

@@ -0,0 +1,17 @@
+# 💼 Prerequisites
+
+To use ReVanced CLI, you will need to fulfil 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
+
+The following section will show you how to use ReVanced CLI.
+
+Continue: [🛠️ Using ReVanced CLI](1_usage.md)

docs/1_usage.md

@@ -0,0 +1,99 @@
+# 🛠️ Using ReVanced CLI
+
+Learn how to ReVanced CLI.
+
+## ⚡ Setup ADB
+
+1. Ensure that ADB is working
+
+   ```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 serial
+
+   ```bash
+   adb devices
+   ```
+
+## 🔨 Using ReVanced CLI
+
+- ### ⚙️ Show all available options for ReVanced CLI
+
+  ```bash
+  java -jar revanced-cli.jar -h
+  ```
+
+- ### 📃 List patches from supplied patch bundles
+
+  ```bash
+  java -jar revanced-cli.jar list-patches \
+   --with-packages \
+   --with-versions \
+   --with-options \
+   revanced-patches.jar [<patch-bundle> ...]
+  ```
+
+- ### ⚙️ 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 of intervention when using the `patch` command.
+
+  ```bash
+
+- ### 💉 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 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 `-m`. If any patches accepted by ReVanced Patcher require ReVanced Integrations, 
+  they will be merged into the APK file automatically.
+
+- ### 🗑️ Uninstall a patched 
+  ```bash
+  java -jar revanced-cli.jar uninstall \
+   --package-name <package-name> \
+   <device-serial>
+  ```

docs/README.md

@@ -0,0 +1,8 @@
+# 💻 Documentation and guides of 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 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.16.1
+version = 3.0.0-dev.1

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.0.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

package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "@saithodev/semantic-release-backmerge": "^3.1.0",
+    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "gradle-semantic-release-plugin": "^1.7.6",
+    "semantic-release": "^20.1.0"
+  }
+}

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,12 +0,0 @@
-package app.revanced.cli.aligning
-
-import app.revanced.cli.command.MainCommand.logger
-import app.revanced.utils.signing.align.ZipAligner
-import java.io.File
-
-object Aligning {
-    fun align(inputFile: File, outputFile: File) {
-        logger.info("Aligning ${inputFile.name} to ${outputFile.name}")
-        ZipAligner.align(inputFile, outputFile)
-    }
-}

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

@@ -0,0 +1,94 @@
+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
+
+
+@Command(name = "list-patches", description = ["List patches from supplied patch bundles"])
+internal object ListPatchesCommand : Runnable {
+    @Parameters(
+        description = ["Paths to patch bundles"],
+        arity = "1..*"
+    )
+    lateinit var patchBundles: Array<File>
+
+    @Option(
+        names = ["-d", "--with-descriptions"],
+        description = ["List their descriptions"],
+        showDefaultValue = ALWAYS
+    )
+    var withDescriptions: Boolean = true
+
+    @Option(
+        names = ["-p", "--with-packages"],
+        description = ["List the packages the patches are compatible with"],
+        showDefaultValue = ALWAYS
+    )
+    var withPackages: Boolean = false
+
+    @Option(
+        names = ["-v", "--with-versions"],
+        description = ["List the versions of the packages the patches are compatible with"],
+        showDefaultValue = ALWAYS
+    )
+    var withVersions: Boolean = false
+
+    @Option(
+        names = ["-o", "--with-options"],
+        description = ["List the options of the patches"],
+        showDefaultValue = ALWAYS
+    )
+    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/Main.kt

@@ -0,0 +1,40 @@
+package app.revanced.cli.command
+
+import app.revanced.cli.logging.impl.DefaultCliLogger
+import app.revanced.patcher.patch.PatchClass
+import picocli.CommandLine
+import picocli.CommandLine.Command
+import picocli.CommandLine.IVersionProvider
+import java.util.*
+
+fun main(args: Array<String>) {
+    CommandLine(Main).execute(*args)
+}
+
+internal typealias PatchList = List<PatchClass>
+
+internal val logger = DefaultCliLogger()
+
+object CLIVersionProvider : IVersionProvider {
+    override fun getVersion(): Array<String> {
+        Properties().apply {
+            load(Main::class.java.getResourceAsStream("/app/revanced/cli/version.properties"))
+        }.let {
+            return arrayOf("ReVanced CLI v${it.getProperty("version")}")
+        }
+    }
+}
+
+@Command(
+    name = "revanced-cli",
+    description = ["Command line application to use ReVanced"],
+    mixinStandardHelpOptions = true,
+    versionProvider = CLIVersionProvider::class,
+    subcommands = [
+        ListPatchesCommand::class,
+        PatchCommand::class,
+        UninstallCommand::class,
+        OptionsCommand::class,
+    ]
+)
+internal object Main

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

@@ -1,254 +0,0 @@
-package app.revanced.cli.command
-
-import app.revanced.cli.aligning.Aligning
-import app.revanced.cli.logging.impl.DefaultCliLogger
-import app.revanced.cli.patcher.Patcher
-import app.revanced.cli.patcher.logging.impl.PatcherLogger
-import app.revanced.cli.signing.Signing
-import app.revanced.cli.signing.SigningOptions
-import app.revanced.patcher.PatcherOptions
-import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
-import app.revanced.patcher.extensions.PatchExtensions.description
-import app.revanced.patcher.extensions.PatchExtensions.patchName
-import app.revanced.patcher.util.patch.PatchBundle
-import app.revanced.utils.OptionsLoader
-import app.revanced.utils.adb.Adb
-import picocli.CommandLine.*
-import java.io.File
-import java.nio.file.Files
-
-private class CLIVersionProvider : IVersionProvider {
-    override fun getVersion() = arrayOf(
-        MainCommand::class.java.`package`.implementationVersion ?: "unknown"
-    )
-}
-
-@Command(
-    name = "ReVanced-CLI",
-    mixinStandardHelpOptions = true,
-    versionProvider = CLIVersionProvider::class
-)
-internal object MainCommand : Runnable {
-    val logger = DefaultCliLogger()
-
-    @ArgGroup(exclusive = false, multiplicity = "1")
-    lateinit var args: Args
-
-    class Args {
-        @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
-        lateinit var inputFile: File
-
-        @Option(names = ["--uninstall"], description = ["Uninstall the mount variant"])
-        var uninstall: Boolean = false
-
-        @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
-        var deploy: String? = null
-
-        @ArgGroup(exclusive = false)
-        var patchArgs: PatchArgs? = null
-    }
-
-    class PatchArgs {
-        @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"], required = true)
-        var patchBundles = arrayOf<String>()
-
-        @Option(names = ["--options"], description = ["Configuration file for all patch options"])
-        var options: File = File("options.toml")
-
-        @ArgGroup(exclusive = false)
-        var listingArgs: ListingArgs? = null
-
-        @ArgGroup(exclusive = false)
-        var patchingArgs: PatchingArgs? = null
-    }
-
-    class ListingArgs {
-        @Option(names = ["-l", "--list"], description = ["List patches only"], required = true)
-        var listOnly: Boolean = false
-
-        @Option(names = ["--with-versions"], description = ["List patches with compatible versions"])
-        var withVersions: Boolean = false
-
-        @Option(names = ["--with-packages"], description = ["List patches with compatible packages"])
-        var withPackages: Boolean = false
-
-        @Option(names = ["--with-descriptions"], description = ["List patches with their descriptions"])
-        var withDescriptions: Boolean = true
-    }
-
-    class PatchingArgs {
-        @Option(names = ["-o", "--out"], description = ["Output file path"], required = true)
-        lateinit var outputPath: String
-
-        @Option(names = ["-e", "--exclude"], description = ["Explicitly exclude patches"])
-        var excludedPatches = arrayOf<String>()
-
-        @Option(
-            names = ["--exclusive"],
-            description = ["Only installs the patches you include, not including any patch by default"]
-        )
-        var defaultExclude = false
-
-        @Option(names = ["-i", "--include"], description = ["Include patches"])
-        var includedPatches = arrayOf<String>()
-
-        @Option(names = ["--experimental"], description = ["Disable patch version compatibility patch"])
-        var experimental: Boolean = false
-
-        @Option(names = ["-m", "--merge"], description = ["One or more dex file containers to merge"])
-        var mergeFiles = listOf<File>()
-
-        @Option(names = ["--mount"], description = ["If specified, instead of installing, mount"])
-        var mount: Boolean = false
-
-        @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"])
-        var cn = "ReVanced"
-
-        @Option(names = ["--keystore"], description = ["File path to your keystore"])
-        var keystorePath: String? = null
-
-        @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
-        var password = "ReVanced"
-
-        @Option(names = ["-t", "--temp-dir"], description = ["Temporary resource cache directory"])
-        var cacheDirectory = "revanced-cache"
-
-        @Option(
-            names = ["-c", "--clean"],
-            description = ["Clean the temporary resource cache directory. This will be done anyways when running the patcher"]
-        )
-        var clean: Boolean = false
-
-        @Option(names = ["--custom-aapt2-binary"], description = ["Path to custom aapt2 binary"])
-        var aaptPath: String = ""
-    }
-
-    override fun run() {
-        if (args.patchArgs?.listingArgs?.listOnly == true) return printListOfPatches()
-        if (args.uninstall) return uninstall()
-
-        val pArgs = this.args.patchArgs?.patchingArgs ?: return
-        val outputFile = File(pArgs.outputPath) // the file to write to
-
-        val allPatches = args.patchArgs!!.patchBundles.flatMap { bundle ->
-            PatchBundle.Jar(bundle).loadPatches()
-        }
-
-        OptionsLoader.init(args.patchArgs!!.options, allPatches)
-
-        val patcher = app.revanced.patcher.Patcher(
-            PatcherOptions(
-                args.inputFile.also { if (!it.exists()) return logger.error("Input file ${args.inputFile} does not exist.") },
-                pArgs.cacheDirectory,
-                pArgs.aaptPath,
-                pArgs.cacheDirectory,
-                PatcherLogger
-            )
-        )
-
-        // prepare adb
-        val adb: Adb? = args.deploy?.let {
-            Adb(outputFile, patcher.context.packageMetadata.packageName, args.deploy!!, !pArgs.mount)
-        }
-
-        val patchedFile = File(pArgs.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
-
-        // start the patcher
-        Patcher.start(patcher, patchedFile, allPatches)
-
-        val cacheDirectory = File(pArgs.cacheDirectory)
-
-        // align the file
-        val alignedFile = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
-        Aligning.align(patchedFile, alignedFile)
-
-        // sign the file
-        val finalFile = if (!pArgs.mount) {
-            val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
-            Signing.sign(
-                alignedFile,
-                signedOutput,
-                SigningOptions(
-                    pArgs.cn,
-                    pArgs.password,
-                    pArgs.keystorePath ?: outputFile.absoluteFile.parentFile
-                        .resolve("${outputFile.nameWithoutExtension}.keystore")
-                        .canonicalPath
-                )
-            )
-
-            signedOutput
-        } else
-            alignedFile
-
-        // finally copy to the specified output file
-        logger.info("Copying ${finalFile.name} to ${outputFile.name}")
-        finalFile.copyTo(outputFile, overwrite = true)
-
-        // clean up the cache directory if needed
-        if (pArgs.clean)
-            cleanUp(pArgs.cacheDirectory)
-
-        // deploy if specified
-        adb?.deploy()
-
-        if (pArgs.clean && args.deploy != null) Files.delete(outputFile.toPath())
-
-        logger.info("Finished")
-    }
-
-    private fun cleanUp(cacheDirectory: String) {
-        val result = if (File(cacheDirectory).deleteRecursively())
-            "Cleaned up cache directory"
-        else
-            "Failed to clean up cache directory"
-        logger.info(result)
-    }
-
-    private fun uninstall() {
-        val adb: Adb? = args.deploy?.let {
-            Adb(
-                File("placeholder_file"),
-                app.revanced.patcher.Patcher(PatcherOptions(args.inputFile, "")).context.packageMetadata.packageName,
-                args.deploy!!,
-                false
-            )
-        }
-        adb?.uninstall()
-    }
-
-    private fun printListOfPatches() {
-        val logged = mutableListOf<String>()
-        for (patchBundlePath in args.patchArgs?.patchBundles!!) for (patch in PatchBundle.Jar(patchBundlePath)
-            .loadPatches()) {
-            if (patch.patchName in logged) continue
-            for (compatiblePackage in patch.compatiblePackages!!) {
-                val packageEntryStr = buildString {
-                    // Add package if flag is set
-                    if (args.patchArgs?.listingArgs?.withPackages == true) {
-                        val packageName = compatiblePackage.name.substringAfterLast(".").padStart(10)
-                        append(packageName)
-                        append("\t")
-                    }
-                    // Add patch name
-                    val patchName = patch.patchName.padStart(25)
-                    append(patchName)
-                    // Add description if flag is set.
-                    if (args.patchArgs?.listingArgs?.withDescriptions == true) {
-                        append("\t")
-                        append(patch.description)
-                    }
-                    // Add compatible versions, if flag is set
-                    if (args.patchArgs?.listingArgs?.withVersions == true) {
-                        val compatibleVersions = compatiblePackage.versions.joinToString(separator = ", ")
-                        append("\t")
-                        append(compatibleVersions)
-                    }
-                }
-
-                logged.add(patch.patchName)
-                logger.info(packageEntryStr)
-            }
-        }
-    }
-}

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

@@ -0,0 +1,50 @@
+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
+
+@CommandLine.Command(
+    name = "options",
+    description = ["Generate options file from patches"],
+)
+internal object OptionsCommand : Runnable {
+    @CommandLine.Parameters(
+        description = ["Paths to patch bundles"],
+        arity = "1..*"
+    )
+    lateinit var patchBundles: Array<File>
+
+    @CommandLine.Option(
+        names = ["-p", "--path"],
+        description = ["Path to patch options JSON file"],
+        showDefaultValue = ALWAYS
+    )
+    var path: File = File("options.json")
+
+    @CommandLine.Option(
+        names = ["-o", "--overwrite"],
+        description = ["Overwrite existing options file"],
+        showDefaultValue = ALWAYS
+    )
+    var overwrite: Boolean = false
+
+    @CommandLine.Option(
+        names = ["-u", "--update"],
+        description = ["Update existing options by adding missing and removing non-existent options"],
+        showDefaultValue = ALWAYS
+    )
+    var update: Boolean = false
+
+    override fun run() = if (!path.exists() || overwrite)
+        with(PatchBundleLoader.Jar(*patchBundles)) {
+            if (update) setOptions(path, logger)
+
+            Options.serialize(this, prettyPrint = true)
+                .let(path::writeText)
+        }
+    else logger.error("Options file already exists, use --override to override it")
+}