chore(release): 4.0.0-dev.4 [skip ci]

# [4.0.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v4.0.0-dev.3...v4.0.0-dev.4) (2023-10-01)

.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/ISSUE_TEMPLATE/bug-issue.yml

@@ -1,73 +0,0 @@
-name: 🐞 Bug report
-description: Report a very clearly broken issue.
-title: 'bug: <title>'
-labels: [bug]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        # ReVanced bug report
-
-        Important to note that your issue may have already been reported before. Please check for existing issues [here](https://github.com/revanced/revanced-cli/labels/bug).
-
-  - type: dropdown
-    attributes:
-      label: Type
-      options:
-        - Error while running the CLI
-        - Error at runtime
-        - Cosmetic
-        - Other
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Bug description
-      description: How did you find the bug? Any additional details that might help?
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Steps to reproduce
-      description: Add the steps to reproduce this bug including your environment.
-      placeholder: Step 1. Download some files. Step 2. ...
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Relevant log output
-      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
-      render: shell
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Screenshots or videos
-      description: Add screenshots or videos that show the bug here.
-      placeholder: Drag and drop the screenshots/videos into this box.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Solution
-      description: If applicable, add a possible solution.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Additional context
-      description: Add additional context here.
-    validations:
-      required: false
-  - type: checkboxes
-    id: acknowledgements
-    attributes:
-      label: Acknowledgements
-      description: Your issue will be closed if you haven't done these steps.
-      options:
-        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
-          required: true
-        - label: I have written a short but informative title.
-          required: true
-        - label: I filled out all of the requested information in this issue properly.
-          required: true

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,49 @@
+name: 🐞 Bug report
+description: Report a bug or an issue.
+title: 'bug: '
+labels: ['Bug report']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # ReVanced CLI bug report
+
+        Please check for existing bug reports
+        [here](https://github.com/ReVanced/revanced-cli/labels/Bug%20report)
+        before creating a new one.
+
+  - type: textarea
+    attributes:
+      label: Bug description
+      description: |
+        - Describe your bug in detail
+        - Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...)
+        - Add images and videos if possible
+        - List used patches if applicable
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Error logs
+      description: Exceptions can be captured by running `logcat | grep AndroidRuntime` in a shell.
+      render: shell
+  - type: textarea
+    attributes:
+      label: Solution
+      description: If applicable, add a possible solution to the bug.
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add additional context here.
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you don't follow the checklist below.
+      options:
+        - label: This request is not a duplicate of an existing issue.
+          required: true
+        - label: I have chosen an appropriate title.
+          required: true
+        - label: All requested information has been provided properly.
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: 📃 Documentation
-    url: https://github.com/revanced/revanced-documentation/
-    about: Don't know how or where to start? Check out our documentation!
   - name: 🗨 Discussions
     url: https://github.com/revanced/revanced-suggestions/discussions
-    about: Got something you think should change or be added? Search for or start a new discussion!
+    about: Have something unspecific to ReVanced CLI in mind? Search for or start a new discussion!

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -1,58 +0,0 @@
-name: ⭐ Feature request
-description: Create a detailed feature request.
-title: 'feat: <title>'
-labels: [feature-request]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        # ReVanced feature request
-        
-        Do not submit requests for patches here. Please submit them [here](https://github.com/orgs/revanced/discussions/categories/patches) instead.
-        Important to note that your feature request may have already been made before. Please check for existing feature requests [here](https://github.com/revanced/revanced-cli/labels/feature-request).
-
-  - type: dropdown
-    attributes:
-      label: Type
-      options:
-        - Functionality
-        - Cosmetic
-        - Other
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Issue
-      description: What is the current problem. Why does it require a feature request?
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Feature
-      description: Describe your feature in detail. How does it solve the issue?
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Motivation
-      description: Why should your feature should be considered?
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Additional context
-      description: Add additional context here.
-    validations:
-      required: false
-  - type: checkboxes
-    id: acknowledgements
-    attributes:
-      label: Acknowledgements
-      description: Your issue will be closed if you haven't done these steps.
-      options:
-        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
-          required: true
-        - label: I have written a short but informative title.
-          required: true
-        - label: I filled out all of the requested information in this issue properly.
-          required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,45 @@
+name: ⭐ Feature request
+description: Create a detailed request for a new feature.
+title: 'feat: '
+labels: ['Feature request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # ReVanced CLI feature request
+
+        Please check for existing feature requests
+        [here](https://github.com/ReVanced/revanced-cli/labels/Feature%20request)
+        before creating a new one.
+
+  - type: textarea
+    attributes:
+      label: Feature description
+      description: |
+        - Describe your feature in detail
+        - Add images, videos, links, examples, references, etc. if possible
+        - Add the target application name in case you request a new patch
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: |
+        A strong motivation is necessary for a feature request to be considered.
+        
+        - Why should this feature be implemented? 
+        - What is the explicit use case?
+        - What are the benefits?
+        - What makes this feature important?
+    validations:
+      required: true
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you don't follow the checklist below.
+      options:
+        - label: This request is not a duplicate of an existing issue.
+          required: true
+        - label: I have chosen an appropriate title.
+          required: true
+        - label: All requested information has been provided properly.
+          required: true

.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

@@ -1,4 +1,4 @@
-name: PR to main
+name: Open a PR to main
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  MESSAGE: merge branch `${{ github.head_ref || github.ref_name }}` to `main`
+  MESSAGE: Merge branch `${{ github.head_ref || github.ref_name }}` to `main`
 
 jobs:
   pull-request:
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Open pull request
         uses: repo-sync/pull-request@v2
         with:

.github/workflows/release.yml

@@ -17,26 +17,30 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        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: Setup JDK
-        uses: actions/setup-java@v3
+      - name: Cache
+        uses: actions/cache@v3
         with:
-          java-version: '17'
-          distribution: 'zulu'
-          cache: gradle
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "latest"
-          cache: 'npm'
-      - name: Setup semantic-release
-        run: npm install semantic-release@19.0.5 @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin@1.7.4 -D
-      - name: Create release
+          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
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+        # Cleaning is necessary to avoid uploading two identical artifacts with different versions
+        run: ./gradlew clean --no-daemon
+      - name: Setup semantic-release
+        run: npm install
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
+        run: npm exec semantic-release

.github/workflows/update-documentation.yml

@@ -9,6 +9,7 @@ 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:

.gitignore

@@ -74,6 +74,7 @@ cmake-build-*/
 
 # IntelliJ
 out/
+.idea
 
 # mpeltonen/sbt-idea plugin
 .idea_modules/

.idea/.gitignore

@@ -1,11 +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
-/vcs.xml
-/codeStyles

.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,7 +7,13 @@
     }
   ],
   "plugins": [
-    "@semantic-release/commit-analyzer",
+    [
+      "@semantic-release/commit-analyzer", {
+        "releaseRules": [
+          { "type": "build", "scope": "Needs bump", "release": "patch" }
+        ]
+      }
+    ],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
     "gradle-semantic-release-plugin",
@@ -34,7 +40,7 @@
     [
       "@saithodev/semantic-release-backmerge",
       {
-        branches: [{from: "main", to: "dev"}],
+        backmergeBranches: [{"from": "main", "to": "dev"}],
         clearWorkspace: true
       }
     ]

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+<p align="center">
+  <picture>
+    <source
+      width="256px"
+      media="(prefers-color-scheme: dark)"
+      srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
+    >
+    <img 
+      src="assets/revanced-headline/revanced-headline-vertical-light.svg"
+    >
+  </picture>
+  <br>
+  <a href="https://revanced.app/">
+       <img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://github.com/revanced">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
+           <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="http://revanced.app/discord">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://reddit.com/r/revancedapp">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://t.me/app_revanced">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://twitter.com/revancedapp">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032018-6da37214-7474-4641-a1da-7af7db3a31cd.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://www.youtube.com/@ReVanced">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <br>
+   <br>
+   Continuing the legacy of Vanced
+</p>
+
+# 📙 ReVanced CLI contribution guidelines
+
+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
+
+## 🙏 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+).
+
+> **Note**
+> Requests can be accepted or rejected at the discretion of maintainers of ReVanced CLI.
+> Good motivation has to be provided for a request to be accepted.
+
+## 🐞 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+).
+
+## 📝 How to contribute
+
+1. Before contributing, it is recommended to open an issue to discuss your change
+   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.
+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,
+ReVanced

README.md

@@ -0,0 +1,75 @@
+<p align="center">
+  <picture>
+    <source
+      width="256px"
+      media="(prefers-color-scheme: dark)"
+      srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
+    >
+    <img 
+      src="assets/revanced-headline/revanced-headline-vertical-light.svg"
+    >
+  </picture>
+  <br>
+  <a href="https://revanced.app/">
+       <img height="24px" src="assets/revanced-logo/revanced-logo-round.svg" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://github.com/revanced">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
+           <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="http://revanced.app/discord">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://reddit.com/r/revancedapp">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://t.me/app_revanced">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://twitter.com/revancedapp">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032018-6da37214-7474-4641-a1da-7af7db3a31cd.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://www.youtube.com/@ReVanced">
+       <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+   </a>&nbsp;&nbsp;&nbsp;
+   <br>
+   <br>
+   Continuing the legacy of Vanced
+</p>
+
+
+# 💻 ReVanced CLI
+
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-cli/release.yml)
+![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)
+
+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.
+
+## 🚀 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
+
+### 📙 Contributing
+
+Thank you for considering contributing to ReVanced CLI.
+You can find the contribution guidelines [here](CONTRIBUTING.md).
+
+### 🛠️ Building
+
+In order to build ReVanced CLI, you can follow the [documentation](/docs).
+
+## 📜 Licence
+
+ReVanced CLI is licensed under the GPLv3 licence. Please see the [licence 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.

build.gradle.kts

@@ -1,45 +1,36 @@
 plugins {
-    kotlin("jvm") version "1.7.0"
-    id("com.github.johnrengelman.shadow") version "7.1.2"
+    kotlin("jvm") version "1.9.0"
+    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(libs.revanced.patcher)
+    implementation(libs.revanced.library)
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.picocli)
 
-    implementation("app.revanced:revanced-patcher:6.4.1")
-    implementation("info.picocli:picocli:4.7.0")
-    implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork
-    implementation("com.android.tools.build:apksig:7.2.1")
-    implementation("org.bouncycastle:bcpkix-jdk15on:1.70")
-    implementation("cc.ekblad:4koma:1.1.0")
+    testImplementation(libs.kotlin.test)
 }
 
+kotlin { jvmToolchain(11) }
+
 tasks {
-    build {
-        dependsOn(shadowJar)
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events("PASSED", "SKIPPED", "FAILED")
+        }
     }
+
+    processResources {
+        expand("projectVersion" to project.version)
+    }
+
     shadowJar {
         manifest {
-            attributes("Main-Class" to "app.revanced.cli.main.MainKt")
+            attributes("Main-Class" to "app.revanced.cli.command.MainCommandKt")
         }
         minimize {
             exclude(dependency("org.jetbrains.kotlin:.*"))
@@ -47,12 +38,26 @@ tasks {
             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
+
+    build {
+        dependsOn(shadowJar)
+    }
+
+    /*
+    Dummy task to hack gradle-semantic-release-plugin to release this project.
+
+    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.
+
+    RE: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
+     */
+
     register<DefaultTask>("publish") {
-        group = "publish"
-        description = "Dummy task"
+        group = "publishing"
+        description = "Dummy task to hack gradle-semantic-release-plugin to release ReVanced CLI"
         dependsOn(build)
     }
 }

docs/0_prerequisites.md

@@ -1,17 +1,17 @@
 # 💼 Prerequisites
 
-To use the ReVanced CLI, you will need to fulfill certain requirements.
+To use ReVanced CLI, you will need to fulfil specific requirements.
 
 ## 🤝 Requirements
 
-- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb), the command-line tool that lets
-  you communicate with a device (optional).
-- A x86/x86_64 host (or a custom AAPT binary for your architecture)
-- Zulu OpenJDK 17
-- An APK file (e.g. YouTube v17.49.37 or YouTube Music v5.36.51)
+- 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 next section will show, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
+The following section will show you how to use ReVanced CLI.
 
-Continue: [🛠️ Using the ReVanced CLI](1_usage.md)
+Continue: [🛠️ Using ReVanced CLI](1_usage.md)

docs/1_usage.md

@@ -1,75 +1,111 @@
-# 🛠️ Using the ReVanced CLI
+# 🛠️ Using ReVanced CLI
 
-Lean how to use the ReVanced CLI.
+Learn how to ReVanced CLI.
 
-## ⚡ Setup (optional)
+## ⚡ Setup ADB
 
-1. Make sure your device is connected
+1. Ensure that ADB is working
 
    ```bash
    adb shell exit
    ```
 
-   If you plan to use the root variant, check if you have root access
+   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. Copy the ADB device name
+2. Get your device's serial
 
    ```bash
    adb devices
    ```
 
-## 🔨 ReVanced CLI Usage
+## 🔨 Using ReVanced CLI
 
-- ### Show all available options for the ReVanced CLI
+- ### ⚙️ Show all available options for ReVanced CLI
 
   ```bash
   java -jar revanced-cli.jar -h
   ```
 
-- ### List all available patches from supplied patch bundles
+- ### 📃 List patches from supplied patch bundles
 
   ```bash
-  java -jar revanced-cli.jar \
-      -b revanced-patches.jar \
-      -l
+  java -jar revanced-cli.jar list-patches \
+   --with-packages \
+   --with-versions \
+   --with-options \
+   revanced-patches.jar [<patch-bundle> ...]
   ```
 
-- ### Use the ReVanced CLI without root permissions
+- ### ⚙️ 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 for intervention when using the `patch` command.
+
+- ### 💉 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 \
+  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 `--merge`. If any patches accepted by ReVanced Patcher require ReVanced Integrations, 
+  they will be merged into the APK file automatically.
+
+- ### 🗑️ Uninstall a patched APK file
+  ```bash
+  java -jar revanced-cli.jar utility uninstall \
+   --package-name <package-name> \
+   <device-serial>
+  ```
+
+  > **Note**: You can unmount an APK file
+  with the option `--unmount`.
+
+- ### ️ ⚙️ Manually install an APK file
+
+  ```bash
+  java -jar revanced-cli.jar utility install \
    -a input.apk \
-   -c \
-   -o unpatched-output.apk \
-   -b revanced-patches.jar
+   <device-serial>
   ```
 
-- ### Mount the patched application with root permissions over the installed application
-
-  ```bash
-  adb install input.apk # make sure the same version is installed
-  java -jar revanced-cli.jar \
-      -a input.apk \
-      -c \
-      -d device-name \
-      -o patched-output.apk \
-      -b revanced-patches.jar \
-      -e microg-support \
-      --mount
-  ```
-
-> **Note**:
->
-> - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you have to exclude
-    the `microg-support` patch from  [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
-    option `-e microg-support`.
->
-> - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require
-    [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`.
->
-> - If you supplied a device with the option `-d`, the patched application will be automatically installed on the
-    device.
+  > **Note**: You can mount an APK file 
+  by supplying the package name of the app to mount the supplied APK file to over the option `--mount`.

docs/README.md

@@ -1,8 +1,8 @@
 # 💻 Documentation and guides of ReVanced CLI
 
-This documentation explain, how to use the [ReVanced CLI](https://github.com/revanced/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 the ReVanced CLI](1_usage.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.20.0-dev.3
+version = 4.0.0-dev.4

gradle/libs.versions.toml

@@ -0,0 +1,17 @@
+[versions]
+shadow = "8.1.1"
+kotlin-test = "1.8.20-RC"
+kotlinx-coroutines-core = "1.7.3"
+picocli = "4.7.3"
+revanced-patcher = "15.0.3"
+revanced-library = "1.1.0"
+
+[libraries]
+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" }
+revanced-library = { module = "app.revanced:revanced-library", version.ref = "revanced-library" }
+
+[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

@@ -1,8 +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.4",
-    "semantic-release": "^19.0.5"
+    "gradle-semantic-release-plugin": "^1.7.6",
+    "semantic-release": "^20.1.0"
   }
 }