ReVanced-Mirror/revanced-cli
1
0
Fork 0
mirror of https://github.com/revanced/revanced-cli.git synced 2025-01-14 13:07:32 +01:00
Code Issues Projects Releases Wiki Activity

feat: Simplify option descriptions

Browse Source
This commit is contained in:
oSumAtrIX 2024-08-14 15:33:17 +02:00
parent 9b03963687
commit 45c998b335
No known key found for this signature in database
GPG Key ID: A9B3094ACDB604B4
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/1_usage.md
View File

@ -24,7 +24,7 @@ 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 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 ```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 -b another-patches.rvp 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: with the key `key1` and `key2` to `value1` and `value2` respectively, use the following command:
```bash ```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: If you want to set the option value to `null`, you can omit the value:
```bash ```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] > [!WARNING]

4
src/main/kotlin/app/revanced/cli/command/ListCompatibleVersions.kt
View File

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

6
src/main/kotlin/app/revanced/cli/command/ListPatchesCommand.kt
View File

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

6
src/main/kotlin/app/revanced/cli/command/PatchCommand.kt
View File

@ -50,7 +50,7 @@ internal object PatchCommand : Runnable {
@CommandLine.Option( @CommandLine.Option(
names = ["--ei"], 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, required = true,
) )
internal var index: Int? = null internal var index: Int? = null
@ -82,7 +82,7 @@ internal object PatchCommand : Runnable {
@CommandLine.Option( @CommandLine.Option(
names = ["--di"], 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, required = true,
) )
internal var index: Int? = null internal var index: Int? = null
@ -200,7 +200,7 @@ internal object PatchCommand : Runnable {
@CommandLine.Option( @CommandLine.Option(
names = ["-p", "--patches"], names = ["-p", "--patches"],
description = ["One or more path to files containing patches."], description = ["One or more path to RVP files."],
required = true, required = true,
) )
@Suppress("unused") @Suppress("unused")