chore: Add click-to-run scripts

# [5.0.0-dev.8](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.7...v5.0.0-dev.8) (2024-10-17)

.github/workflows/release.yml

@@ -10,6 +10,8 @@ on:
 jobs:
   release:
     name: Release
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -46,5 +48,5 @@ jobs:
 
       - name: Release
         env:
-          GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npm exec semantic-release

.gitignore

@@ -122,4 +122,7 @@ revanced-cache/
 options.toml
 
 # Generated by Android projects
-local.properties
+local.properties
+
+# Generated by scripts
+scripts/workspace

.releaserc

@@ -23,7 +23,8 @@
         "assets": [
           "CHANGELOG.md",
           "gradle.properties"
-        ]
+        ],
+        "message": "chore: Release v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
       }
     ],
     [

CHANGELOG.md

@@ -1,3 +1,41 @@
+# [5.0.0-dev.8](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.7...v5.0.0-dev.8) (2024-10-17)
+
+# [5.0.0-dev.7](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.6...v5.0.0-dev.7) (2024-10-16)
+
+
+### Bug Fixes
+
+* Check for null when no device serial was specified ([1da8ae9](https://github.com/ReVanced/revanced-cli/commit/1da8ae9e46000dd3c4eecd793c559e75012cf535))
+
+# [5.0.0-dev.6](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.5...v5.0.0-dev.6) (2024-10-10)
+
+
+### Bug Fixes
+
+* Use the first connected device when no ADB device is specified ([5f952f3](https://github.com/ReVanced/revanced-cli/commit/5f952f35f5cb388b6509b2b4d905b8143ebc7996))
+
+# [5.0.0-dev.5](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.4...v5.0.0-dev.5) (2024-09-30)
+
+# [5.0.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.3...v5.0.0-dev.4) (2024-09-17)
+
+
+### Bug Fixes
+
+* Make patches selectable by using a mutable collection for the selection option ([751fa1d](https://github.com/ReVanced/revanced-cli/commit/751fa1d889f40c51b291116029fd84f2b051f2f0))
+* Make the patch command work without specifying any selection ([ba159a3](https://github.com/ReVanced/revanced-cli/commit/ba159a35a9a99d18a4c1e04128b08ae336a49b3e))
+
+
+### Features
+
+* Show error about no installation device found at the beginning ([3300e6b](https://github.com/ReVanced/revanced-cli/commit/3300e6b4333ed1c4e6785cb82eca9016fc6d4a20))
+
+# [5.0.0-dev.3](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.2...v5.0.0-dev.3) (2024-08-14)
+
+
+### Features
+
+* Simplify option descriptions ([45c998b](https://github.com/ReVanced/revanced-cli/commit/45c998b335b65ac233fece8b804dc7410142691c))
+
 # [5.0.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.1...v5.0.0-dev.2) (2024-08-14)
 
 

docs/0_prerequisites.md

@@ -4,9 +4,9 @@ To use ReVanced CLI, you will need to fulfill specific requirements.
 
 ## 🤝 Requirements
 
-- 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/))
+- Java Runtime Environment 11 or higher ([Eclipse Temurin JRE](https://adoptium.net/temurin/releases/?package=jre) 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)
+- x86 or x86-64 (For [other architectures](https://github.com/ReVanced/revanced-manager/tree/main/android/app/src/main/jniLibs) use the `--custom-aapt2-binary` option)
 
 ## ⏭️ Whats next
 

docs/1_usage.md

@@ -24,10 +24,10 @@ To patch an app using the default list of patches, use the `patch` command:
 java -jar revanced-cli.jar patch -p patches.rvp input.apk
 ```
 
-You can also use multiple files containing patches:
+You can also use multiple RVP files:
 
 ```bash
-java -jar revanced-cli.jar patch -p patches.rvp -b another-patches.rvp input.apk
+java -jar revanced-cli.jar patch -p patches.rvp -p another-patches.rvp input.apk
 ```
 
 To change the default set of enabled or disabled patches, use the option `-e` or `-d` to enable or disable specific patches.
@@ -51,13 +51,13 @@ java -jar revanced-cli.jar list-patches patches.rvp
 Then you can use the indices to enable or disable patches:
 
 ```bash
-java -jar revanced-cli.jar patch -b patches.rvp --ei 123 --di 456 input.apk
+java -jar revanced-cli.jar patch -p patches.rvp --ei 123 --di 456 input.apk
 ```
 
 You can combine the option `-e`, `-d`, `--ei`, `--di` and `--exclusive`. Here is an example:
 
 ```bash
-java -jar revanced-cli.jar patch -p patches.rvp --exclusive -i "Patch name" --ei 123 input.apk
+java -jar revanced-cli.jar patch -p patches.rvp --exclusive -e "Patch name" --ei 123 input.apk
 ```
 
 
@@ -91,13 +91,13 @@ For example, to set the options for the patch with the name `Patch name`
 with the key `key1` and `key2` to `value1` and `value2` respectively, use the following command:
 
 ```bash
-java -jar revanced-cli.jar patch -b patches.rvp -e "Patch name" -Okey1=value1 -Okey2=value2 input.apk
+java -jar revanced-cli.jar patch -p patches.rvp -e "Patch name" -Okey1=value1 -Okey2=value2 input.apk
 ```
 
 If you want to set the option value to `null`, you can omit the value:
 
 ```bash
-java -jar revanced-cli.jar patch -b revanced-patches.rvp -i "Patch name" -Okey1 input.apk
+java -jar revanced-cli.jar patch -p patches.rvp -i "Patch name" -Okey1 input.apk
 ```
 
 > [!WARNING]

gradle.properties

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

gradle/libs.versions.toml

@@ -1,9 +1,9 @@
 [versions]
 shadow = "8.1.1"
-kotlin = "2.0.0"
+kotlin = "2.0.20"
 kotlinx = "1.8.1"
 picocli = "4.7.6"
-revanced-patcher = "20.0.0"
+revanced-patcher = "20.0.2"
 revanced-library = "3.0.0"
 
 [libraries]

package.json

@@ -3,7 +3,7 @@
     "@saithodev/semantic-release-backmerge": "^4.0.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "gradle-semantic-release-plugin": "^1.9.1",
+    "gradle-semantic-release-plugin": "^1.10.1",
-    "semantic-release": "^23.0.8"
+    "semantic-release": "^24.1.2"
   }
 }

scripts/1-setup-environment.bat

@@ -0,0 +1,29 @@
+@echo off
+
+echo Check, if OpenJDK/ Eclipse Temurin 11 or newer is installed.
+pause
+echo:
+
+cd modules
+call run java -version
+cd ..
+
+echo:
+set /P INSTALLED_JAVA=Can you see OpenJDK/ Eclipse Temurin 11 or newer? (y/n)
+
+if "%INSTALLED_JAVA%"=="y" (
+    echo The environment is set up.
+    pause
+    exit
+)
+
+cls
+echo Install Eclipse Temurin JRE 21.
+pause
+
+cd modules
+call install-java
+cd ..
+
+echo The environment is set up. Rerun this script to check your environment.
+pause

scripts/2-download.bat

@@ -0,0 +1,11 @@
+@echo off
+
+echo Download necessary files from GitHub.
+pause
+
+cd modules
+call composite download %~dp0\workspace
+cd ..
+
+echo Files downloaded.
+pause

scripts/3-patch.bat

@@ -0,0 +1,14 @@
+@echo off
+setlocal
+
+echo Patch an APK with the patches in the workspace.
+pause
+
+cd modules
+call composite patch %~dp0\workspace
+cd ..
+
+mv %~dp0\workspace\patched.apk %~dp0\patched.apk
+
+echo Patched APK saved at %~dp0\patched.apk.
+pause

scripts/4-cleanup.bat

@@ -0,0 +1,11 @@
+@echo off
+
+echo Clean the workspace.
+pause
+
+cd modules
+call composite clean %~dp0\workspace
+cd ..
+
+echo Cleaned workspace.
+pause

scripts/README.md

@@ -0,0 +1,8 @@
+# 📜 Scripts
+
+This directory contain click-to-run scripts to use ReVanced CLI.
+
+## Prerequisites
+
+- [cURL](https://curl.haxx.se/)
+- [WinGet](https://aka.ms/getwinget), if you are on Windows

scripts/customize.bat

@@ -0,0 +1 @@
+notepad modules\env.bat

scripts/modules/check-java.bat

@@ -0,0 +1,12 @@
+@echo off
+setlocal
+
+for /f "tokens=8 delims=. " %%a in ('java --version 2^>nul ^| findstr /r "build"') do (
+    set JAVA_VERSION_MAJOR=%%a
+    goto :break
+)
+:break
+
+if %JAVA_VERSION_MAJOR% LSS 11 (
+    echo It looks like Java version is less than 11. Install OpenJDK/ Eclipse Temurin 11 or newer.
+)

scripts/modules/composite.bat

@@ -0,0 +1,51 @@
+@echo off
+setlocal EnableDelayedExpansion
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if "%~2"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Runs curated compositions of scripts.
+    echo:
+    echo Usage: composite ^<script^> ^<workspace^>
+    echo Example: composite patch C:/revanced
+    echo:
+    echo Available commands:
+    echo:   download - Download files
+    echo:   patch - Patches an application
+    echo:   clean - Cleans the workspace
+    echo:   env - Check for a valid environment setup
+    exit /b 1
+)
+
+call env
+
+set WORKSPACE=%2
+
+if "%~1"=="download" (
+   call create %WORKSPACE%
+
+    if not exist %WORKSPACE%/revanced-cli.jar (
+        echo Downloading ReVanced CLI...
+        call download %CLI_REPO% jar %WORKSPACE%/revanced-cli.jar
+    )
+
+    if not exist %WORKSPACE%/patches.rvp (
+        echo Downloading ReVanced patches...
+        call download %PATCHES_REPO% jar %WORKSPACE%/patches.rvp
+    )
+)
+if "%~1"=="patch" (
+    set /p APK="Path to the APK file: "
+
+    call patch !APK! %WORKSPACE%
+)
+if "%~1"=="clean" (
+    call delete %WORKSPACE%
+)
+if "%~1"=="env" (
+    call check-java
+)

scripts/modules/create.bat

@@ -0,0 +1,19 @@
+@echo off
+setlocal
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Creates a directory using the mkdir command.
+    echo:
+    echo Usage: create ^<path^>
+    echo Example: create C:/revanced
+    exit /b 1
+)
+
+set DIRECTORY=%1
+
+if not exist %DIRECTORY% (
+    run "mkdir.exe" -p %DIRECTORY%
+)

scripts/modules/delete.bat

@@ -0,0 +1,20 @@
+@echo off
+setlocal
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Deletes a directory relative to the current directory using the rmdir command.
+    echo:
+    echo Usage: delete ^<path^>
+    echo Example: delete C:/revanced
+    exit /b 1
+)
+
+set DIRECTORY=%1
+
+if exist %DIRECTORY% (
+    echo Confirm deletion of
+    run rmdir /s %DIRECTORY%
+)

scripts/modules/download.bat

@@ -0,0 +1,30 @@
+@echo off
+setlocal
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if "%~2"=="" (
+    set INVALID_ARGS=true
+)
+if "%~3"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Downloads a file from a GitHub repository release.
+    echo:
+    echo Usage: download ^<repo^> ^<asset-extension^> ^<out^>
+    echo Example: download revanced/revanced-cli jar C:/revanced/revanced-cli.jar
+    exit /b 1
+)
+
+set REPO=%1
+set ASSET_EXTENSION=%2
+set OUT=%3
+
+set URL=https://api.github.com/repos/%REPO%/releases/latest
+for /f "delims=" %%i in ('curl -s %URL% ^| jq -r ".assets[] | select(.name | endswith(\"%ASSET_EXTENSION%\")) | .browser_download_url"') do (
+    set JAR_URL=%%i
+)
+
+run curl --silent --location --output %OUT% %JAR_URL%

scripts/modules/env.bat

@@ -0,0 +1,6 @@
+@echo off
+
+:: Customize your environment.
+
+set CLI_REPO=revanced/revanced-cli
+set PATCHES_REPO=revanced/revanced-patches

scripts/modules/install-java.bat

@@ -0,0 +1 @@
+run install EclipseAdoptium.Temurin.21.JRE

scripts/modules/install-jq.bat

@@ -0,0 +1 @@
+run install jqlang.jq

scripts/modules/install.bat

@@ -0,0 +1,14 @@
+@echo off
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Installs a package using winget.
+    echo:
+    echo Usage: install ^<id^>
+    echo Example: install jqlang.jq
+    exit /b 1
+)
+
+run winget install -e --id=%1

scripts/modules/patch.bat

@@ -0,0 +1,28 @@
+@echo off
+setlocal
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if "%~2"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Patches an application using the specified patches.
+    echo:
+    echo Usage: patch ^<apk^> ^<workspace^>
+    echo Example: patch C:/app.apk C:/workspace
+    exit /b 1
+)
+
+set APK=%1
+set WORKSPACE=%2
+
+call run java -jar %WORKSPACE%/revanced-cli.jar patch ^
+    --patch-bundle %WORKSPACE%/patches.rvp ^
+    --temporary-files-path %WORKSPACE%/temporary-files ^
+    --out %WORKSPACE%/patched.apk ^
+    --purge ^
+    %APK%
+
+mv %WORKSPACE%/patched.apk

scripts/modules/run.bat

@@ -0,0 +1,23 @@
+@echo off
+
+if "%~1"=="" (
+    set INVALID_ARGS=true
+)
+if defined INVALID_ARGS (
+    echo Run a command with arguments.
+    echo:
+    echo Usage: run.bat ^<command^> [arguments]
+    echo Example: run.bat echo Hello, World!
+    exit /b 1
+)
+
+%*
+
+if %ERRORLEVEL% NEQ 0 (
+    echo:
+    echo Failed to run command with exit code %ERRORLEVEL%.
+    echo Failed command: %*
+    echo:
+    pause
+    exit /b %ERRORLEVEL%
+)

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

@@ -12,14 +12,14 @@ import java.util.logging.Logger
     name = "list-versions",
     description = [
         "List the most common compatible versions of apps that are compatible " +
-            "with the patches in the supplied files containing patches.",
+            "with the patches from RVP files.",
     ],
 )
 internal class ListCompatibleVersions : Runnable {
     private val logger = Logger.getLogger(this::class.java.name)
 
     @CommandLine.Parameters(
-        description = ["One or more paths to files containing patches."],
+        description = ["Paths to RVP files."],
         arity = "1..*",
     )
     private lateinit var patchesFiles: Set<File>

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

@@ -11,13 +11,13 @@ import app.revanced.patcher.patch.Option as PatchOption
 
 @Command(
     name = "list-patches",
-    description = ["List patches from supplied files containing patches."],
+    description = ["List patches from supplied RVP files."],
 )
 internal object ListPatchesCommand : Runnable {
     private val logger = Logger.getLogger(this::class.java.name)
 
     @Parameters(
-        description = ["One or more paths to files containing patches."],
+        description = ["Paths to RVP files."],
         arity = "1..*",
     )
     private lateinit var patchesFiles: Set<File>
@@ -59,7 +59,7 @@ internal object ListPatchesCommand : Runnable {
 
     @Option(
         names = ["-i", "--index"],
-        description = ["List the index of each patch in relation to the supplied files containing patches."],
+        description = ["List the index of each patch in relation to the supplied RVP files."],
         showDefaultValue = ALWAYS,
     )
     private var withIndex: Boolean = true

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

@@ -30,7 +30,7 @@ internal object PatchCommand : Runnable {
     private lateinit var spec: CommandSpec
 
     @ArgGroup(multiplicity = "0..*")
-    private lateinit var selection: Set<Selection>
+    private var selection = mutableSetOf<Selection>()
 
     internal class Selection {
         @ArgGroup(exclusive = false, multiplicity = "1")
@@ -50,7 +50,7 @@ internal object PatchCommand : Runnable {
 
                 @CommandLine.Option(
                     names = ["--ei"],
-                    description = ["Index of the patch in the combined list of all supplied files containing patches."],
+                    description = ["Index of the patch in the combined list of the supplied RVP files."],
                     required = true,
                 )
                 internal var index: Int? = null
@@ -82,7 +82,7 @@ internal object PatchCommand : Runnable {
 
                 @CommandLine.Option(
                     names = ["--di"],
-                    description = ["Index of the patch in the combined list of all supplied files containing patches."],
+                    description = ["Index of the patch in the combined list of the supplied RVP files."],
                     required = true,
                 )
                 internal var index: Int? = null
@@ -200,7 +200,7 @@ internal object PatchCommand : Runnable {
 
     @CommandLine.Option(
         names = ["-p", "--patches"],
-        description = ["One or more path to files containing patches."],
+        description = ["One or more path to RVP files."],
         required = true,
     )
     @Suppress("unused")
@@ -245,6 +245,34 @@ internal object PatchCommand : Runnable {
             keyStoreFilePath ?: outputFilePath.parentFile
                 .resolve("${outputFilePath.nameWithoutExtension}.keystore")
 
+        val installer = if (deviceSerial != null) {
+            val deviceSerial = deviceSerial!!.ifEmpty { null }
+
+            try {
+                if (mount) {
+                    AdbRootInstaller(deviceSerial)
+                } else {
+                    AdbInstaller(deviceSerial)
+                }
+            } catch (e: DeviceNotFoundException) {
+                if (deviceSerial?.isNotEmpty() == true) {
+                    logger.severe(
+                        "Device with serial $deviceSerial not found to install to. " +
+                            "Ensure the device is connected and the serial is correct when using the --install option.",
+                    )
+                } else {
+                    logger.severe(
+                        "No device has been found to install to. " +
+                            "Ensure a device is connected when using the --install option.",
+                    )
+                }
+
+                return
+            }
+        } else {
+            null
+        }
+
         // endregion
 
         // region Load patches
@@ -332,13 +360,7 @@ internal object PatchCommand : Runnable {
             val deviceSerial = it.ifEmpty { null }
 
             runBlocking {
-                val result = if (mount) {
+                when (val result = installer!!.install(Installer.Apk(outputFilePath, packageName))) {
-                    AdbRootInstaller(deviceSerial)
-                } else {
-                    AdbInstaller(deviceSerial)
-                }.install(Installer.Apk(outputFilePath, packageName))
-
-                when (result) {
                     RootInstallerResult.FAILURE -> logger.severe("Failed to mount the patched APK file")
                     is AdbInstallerResult.Failure -> logger.severe(result.exception.toString())
                     else -> logger.info("Installed the patched APK file")
@@ -366,14 +388,14 @@ internal object PatchCommand : Runnable {
         packageVersion: String,
     ): Set<Patch<*>> = buildSet {
         val enabledPatchesByName =
-            selection.asSequence().mapNotNull { it.enabled?.selector?.name }.toSet()
+            selection.mapNotNull { it.enabled?.selector?.name }.toSet()
         val enabledPatchesByIndex =
-            selection.asSequence().mapNotNull { it.enabled?.selector?.index }.toSet()
+            selection.mapNotNull { it.enabled?.selector?.index }.toSet()
 
         val disabledPatches =
-            selection.asSequence().mapNotNull { it.disable?.selector?.name }.toSet()
+            selection.mapNotNull { it.disable?.selector?.name }.toSet()
         val disabledPatchesByIndex =
-            selection.asSequence().mapNotNull { it.disable?.selector?.index }.toSet()
+            selection.mapNotNull { it.disable?.selector?.index }.toSet()
 
         this@filterPatchSelection.withIndex().forEach patchLoop@{ (i, patch) ->
             val patchName = patch.name!!