docs: Use American spelling (#381)

Co-authored-by: oSumAtrIX <johan.melkonyan1@web.de>

.github/workflows/build_pull_request.yml

@@ -13,8 +13,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
 
       - name: Cache Gradle
         uses: burrunan/gradle-cache-action@v1

.github/workflows/release.yml

@@ -12,15 +12,12 @@ jobs:
     name: Release
     permissions:
       contents: write
+      id-token: write
+      attestations: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        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: Cache Gradle
         uses: burrunan/gradle-cache-action@v1
@@ -47,6 +44,14 @@ jobs:
           fingerprint: ${{ vars.GPG_FINGERPRINT }}
 
       - name: Release
+        uses: cycjimmy/semantic-release-action@v4
+        id: release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm exec semantic-release
+
+      - name: Attest
+        if: steps.release.outputs.new_release_published == 'true'
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: 'ReVanced CLI ${{ steps.release.outputs.new_release_git_tag }}'
+          subject-path: build/libs/revanced-cli*.jar

CHANGELOG.md

@@ -1,3 +1,72 @@
+## [5.0.2-dev.2](https://github.com/ReVanced/revanced-cli/compare/v5.0.2-dev.1...v5.0.2-dev.2) (2025-04-25)
+
+
+### Bug Fixes
+
+* Do not print patch description if null ([bba90fe](https://github.com/ReVanced/revanced-cli/commit/bba90fede85e4632efb9509e5bcf9091a9435549))
+
+## [5.0.2-dev.1](https://github.com/ReVanced/revanced-cli/compare/v5.0.1...v5.0.2-dev.1) (2025-04-20)
+
+
+### Bug Fixes
+
+* Group `mount` and `install` options into an argument group  ([#364](https://github.com/ReVanced/revanced-cli/issues/364)) ([0c53a2d](https://github.com/ReVanced/revanced-cli/commit/0c53a2d1d75d3d934d134594751fe6cd0b000d1a))
+
+## [5.0.1](https://github.com/ReVanced/revanced-cli/compare/v5.0.0...v5.0.1) (2025-04-14)
+
+
+### Bug Fixes
+
+* Make mounting work again by bumping dependencies ([#359](https://github.com/ReVanced/revanced-cli/issues/359)) ([68a4872](https://github.com/ReVanced/revanced-cli/commit/68a48724ebf01a0c8f8adc0fec63037bff672dc9))
+
+## [5.0.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v5.0.0...v5.0.1-dev.1) (2025-02-26)
+
+
+### Bug Fixes
+
+* Make mounting work again by bumping dependencies ([#359](https://github.com/ReVanced/revanced-cli/issues/359)) ([68a4872](https://github.com/ReVanced/revanced-cli/commit/68a48724ebf01a0c8f8adc0fec63037bff672dc9))
+
+# [5.0.0](https://github.com/ReVanced/revanced-cli/compare/v4.6.0...v5.0.0) (2024-11-10)
+
+
+### Bug Fixes
+
+* Check for null when no device serial was specified ([1da8ae9](https://github.com/ReVanced/revanced-cli/commit/1da8ae9e46000dd3c4eecd793c559e75012cf535))
+* List if patch option is required ([#346](https://github.com/ReVanced/revanced-cli/issues/346)) ([98ff0c3](https://github.com/ReVanced/revanced-cli/commit/98ff0c34fa71c3b3ecd96157d45a30ee2b8979c6))
+* Make CLI ArgGroup non-exclusive to be able to disable and enable patches at the same time ([1bb0d13](https://github.com/ReVanced/revanced-cli/commit/1bb0d13726fd5790c59cb6d28df3618c7606710d))
+* 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))
+* Print in new line correctly ([c2dc9d7](https://github.com/ReVanced/revanced-cli/commit/c2dc9d76be33c98284741e23c406500483c47753))
+* Use the first connected device when no ADB device is specified ([5f952f3](https://github.com/ReVanced/revanced-cli/commit/5f952f35f5cb388b6509b2b4d905b8143ebc7996))
+
+
+### Features
+
+* Set patch options via CLI ([#336](https://github.com/ReVanced/revanced-cli/issues/336)) ([2300243](https://github.com/ReVanced/revanced-cli/commit/23002434b2d51c2a3b30b33dd0526261432d90ce))
+* Show error about no installation device found at the beginning ([3300e6b](https://github.com/ReVanced/revanced-cli/commit/3300e6b4333ed1c4e6785cb82eca9016fc6d4a20))
+* Simplify command and option names and descriptions ([#338](https://github.com/ReVanced/revanced-cli/issues/338)) ([6e7797a](https://github.com/ReVanced/revanced-cli/commit/6e7797a3f0525a8f48af7182157da0d045600ac2))
+* Simplify option descriptions ([45c998b](https://github.com/ReVanced/revanced-cli/commit/45c998b335b65ac233fece8b804dc7410142691c))
+
+
+### BREAKING CHANGES
+
+* Options have been renamed.
+* This commit changes various CLI options and removes the `options.json` file. Instead, patch options can now be passed via CLI options
+
+# [5.0.0-dev.11](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.10...v5.0.0-dev.11) (2024-11-10)
+
+
+### Bug Fixes
+
+* List if patch option is required ([#346](https://github.com/ReVanced/revanced-cli/issues/346)) ([98ff0c3](https://github.com/ReVanced/revanced-cli/commit/98ff0c34fa71c3b3ecd96157d45a30ee2b8979c6))
+
+# [5.0.0-dev.10](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.9...v5.0.0-dev.10) (2024-11-05)
+
+
+### Bug Fixes
+
+* Make CLI ArgGroup non-exclusive to be able to disable and enable patches at the same time ([1bb0d13](https://github.com/ReVanced/revanced-cli/commit/1bb0d13726fd5790c59cb6d28df3618c7606710d))
+
 # [5.0.0-dev.9](https://github.com/ReVanced/revanced-cli/compare/v5.0.0-dev.8...v5.0.0-dev.9) (2024-11-05)
 
 

README.md

@@ -100,7 +100,7 @@ To build a ReVanced CLI, you can follow the [documentation](/docs).
 
 You can find the documentation of ReVanced CLI [here](/docs).
 
-## 📜 Licence
+## 📜 License
 
 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.

build.gradle.kts

@@ -59,10 +59,10 @@ tasks {
     }
 
     shadowJar {
+        exclude("/prebuilt/linux/aapt", "/prebuilt/windows/aapt.exe", "/prebuilt/*/aapt_*")
         minimize {
-            exclude(dependency("org.jetbrains.kotlin:.*"))
             exclude(dependency("org.bouncycastle:.*"))
-            exclude(dependency("app.revanced:.*"))
+            exclude(dependency("app.revanced:revanced-patcher"))
         }
     }
 

gradle.properties

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

gradle/libs.versions.toml

@@ -3,8 +3,8 @@ shadow = "8.1.1"
 kotlin = "2.0.20"
 kotlinx = "1.8.1"
 picocli = "4.7.6"
-revanced-patcher = "20.0.2"
+revanced-patcher = "21.0.0"
-revanced-library = "3.0.0"
+revanced-library = "3.1.0"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }

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

@@ -85,57 +85,55 @@ internal object ListPatchesCommand : Runnable {
             }
         }
 
-        fun PatchOption<*>.buildString() =
+        fun PatchOption<*>.buildString() = buildString {
+            appendLine("Title: $title")
+            description?.let { appendLine("Description: $it") }
+            appendLine("Required: $required")
+            default?.let {
+                appendLine("Key: $key")
+                append("Default: $it")
+            } ?: append("Key: $key")
+
+            values?.let { values ->
+                appendLine("\nPossible values:")
+                append(values.map { "${it.value} (${it.key})" }.joinToString("\n").prependIndent("\t"))
+            }
+
+            append("\nType: $type")
+        }
+
+        fun IndexedValue<Patch<*>>.buildString() = let { (index, patch) ->
             buildString {
-                appendLine("Title: $title")
+                if (withIndex) appendLine("Index: $index")
-                description?.let { appendLine("Description: $it") }
-                default?.let {
-                    appendLine("Key: $key")
-                    append("Default: $it")
-                } ?: append("Key: $key")
 
-                values?.let { values ->
+                append("Name: ${patch.name}")
-                    appendLine("\nPossible values:")
+
-                    append(values.map { "${it.value} (${it.key})" }.joinToString("\n").prependIndent("\t"))
+                if (withDescriptions) patch.description?.let { append("\nDescription: $it") }
+
+                append("\nEnabled: ${patch.use}")
+
+                if (withOptions && patch.options.isNotEmpty()) {
+                    appendLine("\nOptions:")
+                    append(
+                        patch.options.values.joinToString("\n\n") { option ->
+                            option.buildString()
+                        }.prependIndent("\t"),
+                    )
                 }
 
-                append("\nType: $type")
+                if (withPackages && patch.compatiblePackages != null) {
-            }
+                    appendLine("\nCompatible packages:")
-
+                    append(
-        fun IndexedValue<Patch<*>>.buildString() =
+                        patch.compatiblePackages!!.joinToString("\n") {
-            let { (index, patch) ->
+                            it.buildString()
-                buildString {
+                        }.prependIndent("\t"),
-                    if (withIndex) appendLine("Index: $index")
+                    )
-
-                    append("Name: ${patch.name}")
-
-                    if (withDescriptions) append("\nDescription: ${patch.description}")
-
-                    append("\nEnabled: ${patch.use}")
-
-                    if (withOptions && patch.options.isNotEmpty()) {
-                        appendLine("\nOptions:")
-                        append(
-                            patch.options.values.joinToString("\n\n") { option ->
-                                option.buildString()
-                            }.prependIndent("\t"),
-                        )
-                    }
-
-                    if (withPackages && patch.compatiblePackages != null) {
-                        appendLine("\nCompatible packages:")
-                        append(
-                            patch.compatiblePackages!!.joinToString("\n") {
-                                it.buildString()
-                            }.prependIndent("\t"),
-                        )
-                    }
                 }
             }
+        }
 
-        fun Patch<*>.filterCompatiblePackages(name: String) =
+        fun Patch<*>.filterCompatiblePackages(name: String) = compatiblePackages?.any { (compatiblePackageName, _) -> compatiblePackageName == name }
-            compatiblePackages?.any { (compatiblePackageName, _) -> compatiblePackageName == name }
+            ?: withUniversalPatches
-                ?: withUniversalPatches
 
         val patches = loadPatchesFromJar(patchesFiles).withIndex().toList()
 

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

@@ -29,11 +29,11 @@ internal object PatchCommand : Runnable {
     @Spec
     private lateinit var spec: CommandSpec
 
-    @ArgGroup(multiplicity = "0..*")
+    @ArgGroup(exclusive = false, multiplicity = "0..*")
     private var selection = mutableSetOf<Selection>()
 
     internal class Selection {
-        @ArgGroup(exclusive = false, multiplicity = "1")
+        @ArgGroup(exclusive = false)
         internal var enabled: EnableSelection? = null
 
         internal class EnableSelection {
@@ -65,7 +65,7 @@ internal object PatchCommand : Runnable {
             internal var options = mutableMapOf<String, Any?>()
         }
 
-        @ArgGroup(exclusive = false, multiplicity = "1")
+        @ArgGroup(exclusive = false)
         internal var disable: DisableSelection? = null
 
         internal class DisableSelection {
@@ -115,21 +115,27 @@ internal object PatchCommand : Runnable {
         this.outputFilePath = outputFilePath?.absoluteFile
     }
 
-    @CommandLine.Option(
+    @ArgGroup(exclusive = false, multiplicity = "0..1")
-        names = ["-i", "--install"],
+    internal var installation: Installation? = null
-        description = ["Serial of the ADB device to install to. If not specified, the first connected device will be used."],
-        // Empty string to indicate that the first connected device should be used.
-        fallbackValue = "",
-        arity = "0..1",
-    )
-    private var deviceSerial: String? = null
 
-    @CommandLine.Option(
+    internal class Installation {
-        names = ["--mount"],
+        @CommandLine.Option(
-        description = ["Install the patched APK file by mounting."],
+            names = ["-i", "--install"],
-        showDefaultValue = ALWAYS,
+            required = true,
-    )
+            description = ["Serial of the ADB device to install to. If not specified, the first connected device will be used."],
-    private var mount: Boolean = false
+            fallbackValue = "",  // Empty string is used to select the first of connected devices.
+            arity = "0..1",
+        )
+        internal var deviceSerial: String? = null
+
+        @CommandLine.Option(
+            names = ["--mount"],
+            required = false,
+            description = ["Install the patched APK file by mounting."],
+            showDefaultValue = ALWAYS,
+        )
+        internal var mount: Boolean = false
+    }
 
     @CommandLine.Option(
         names = ["--keystore"],
@@ -245,11 +251,11 @@ internal object PatchCommand : Runnable {
             keyStoreFilePath ?: outputFilePath.parentFile
                 .resolve("${outputFilePath.nameWithoutExtension}.keystore")
 
-        val installer = if (deviceSerial != null) {
+        val installer = if (installation?.deviceSerial != null) {
-            val deviceSerial = deviceSerial!!.ifEmpty { null }
+            val deviceSerial = installation?.deviceSerial!!.ifEmpty { null }
 
             try {
-                if (mount) {
+                if (installation?.mount == true) {
                     AdbRootInstaller(deviceSerial)
                 } else {
                     AdbInstaller(deviceSerial)
@@ -291,7 +297,6 @@ internal object PatchCommand : Runnable {
                 patcherTemporaryFilesPath,
                 aaptBinaryPath?.path,
                 patcherTemporaryFilesPath.absolutePath,
-                true,
             ),
         ).use { patcher ->
             val packageName = patcher.context.packageMetadata.packageName
@@ -333,7 +338,7 @@ internal object PatchCommand : Runnable {
         apk.copyTo(temporaryFilesPath.resolve(apk.name), overwrite = true).apply {
             patcherResult.applyTo(this)
         }.let { patchedApkFile ->
-            if (!mount) {
+            if (installation?.mount != true) {
                 ApkUtils.signApk(
                     patchedApkFile,
                     outputFilePath,
@@ -356,7 +361,7 @@ internal object PatchCommand : Runnable {
 
         // region Install.
 
-        deviceSerial?.let {
+        installation?.deviceSerial?.let {
             runBlocking {
                 when (val result = installer!!.install(Installer.Apk(outputFilePath, packageName))) {
                     RootInstallerResult.FAILURE -> logger.severe("Failed to mount the patched APK file")