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

## [4.5.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.5.0...v4.5.1-dev.1) (2024-03-12)

### Bug Fixes

* Copy APK to output path when it is not being signed ([366f400](366f400c5a))

.editorconfig

@@ -0,0 +1,3 @@
+[*.{kt,kts}]
+ktlint_code_style = intellij_idea
+ktlint_standard_no-wildcard-imports = disabled

.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,110 @@
+name: 🐞 Bug report
+description: Report a bug or an issue.
+title: 'bug: '
+labels: ['Bug report']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        <p align="center">
+          <picture>
+            <source
+              width="256px"
+              media="(prefers-color-scheme: dark)"
+              srcset="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-headline/revanced-headline-vertical-dark.svg"
+            >
+            <img 
+              width="256px"
+              src="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-headline/revanced-headline-vertical-light.svg"
+            >
+          </picture>
+          <br>
+          <a href="https://revanced.app/">
+             <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-logo/revanced-logo.svg" />
+                 <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-logo/revanced-logo.svg" />
+             </picture>
+           </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">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://reddit.com/r/revancedapp">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://t.me/app_revanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://x.com/revancedapp">
+              <picture>
+                 <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+                 <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://www.youtube.com/@ReVanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+             </picture>
+           </a>
+           <br>
+           <br>
+           Continuing the legacy of Vanced
+        </p>
+
+        # ReVanced CLI bug report
+
+        Before creating a new bug report, please keep the following in mind:
+
+        - **Do not submit a duplicate bug report**: You can review existing bug reports [here](https://github.com/ReVanced/revanced-cli/labels/Bug%20report).
+        - **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-cli/blob/main/CONTRIBUTING.md).
+        - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+  - 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 bug report will be closed if you don't follow the checklist below.
+      options:
+        - label: This issue is not a duplicate of an existing bug report.
+          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,106 @@
+name: ⭐ Feature request
+description: Create a detailed request for a new feature.
+title: 'feat: '
+labels: ['Feature request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        <p align="center">
+          <picture>
+            <source
+              width="256px"
+              media="(prefers-color-scheme: dark)"
+              srcset="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-headline/revanced-headline-vertical-dark.svg"
+            >
+            <img 
+              width="256px"
+              src="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-headline/revanced-headline-vertical-light.svg"
+            >
+          </picture>
+          <br>
+          <a href="https://revanced.app/">
+             <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-logo/revanced-logo.svg" />
+                 <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-cli/main/assets/revanced-logo/revanced-logo.svg" />
+             </picture>
+           </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">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://reddit.com/r/revancedapp">
+               <picture>
+                   <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+                   <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+               </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://t.me/app_revanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://x.com/revancedapp">
+              <picture>
+                 <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+                 <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+              </picture>
+           </a>&nbsp;&nbsp;&nbsp;
+           <a href="https://www.youtube.com/@ReVanced">
+              <picture>
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+                 <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+             </picture>
+           </a>
+           <br>
+           <br>
+           Continuing the legacy of Vanced
+        </p>
+
+        # ReVanced CLI feature request
+
+        Before creating a new feature request, please keep the following in mind:
+
+        - **Do not submit a duplicate feature request**: You can review existing feature requests [here](https://github.com/ReVanced/revanced-cli//labels/Feature%20request).
+        - **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-cli//blob/main/CONTRIBUTING.md).
+        - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+  - 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 feature request will be closed if you don't follow the checklist below.
+      options:
+        - label: This issue is not a duplicate of an existing feature request.
+          required: true
+        - label: I have chosen an appropriate title.
+          required: true
+        - label: All requested information has been provided properly.
+          required: true

.github/config.yml

@@ -1,2 +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.
+  Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) to receive a role for your contribution.

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: gradle
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly

.github/workflows/build_pull_request.yml

@@ -0,0 +1,25 @@
+name: Build pull request
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - dev
+
+jobs:
+  release:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Cache Gradle
+        uses: burrunan/gradle-cache-action@v1
+
+      - name: Build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./gradlew build --no-daemon

.github/workflows/open_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,8 @@ 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

@@ -6,10 +6,6 @@ on:
     branches:
       - main
       - dev
-  pull_request:
-    branches:
-      - main
-      - dev
 
 jobs:
   release:
@@ -17,25 +13,37 @@ 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
-        with:
-          java-version: '17'
-          distribution: 'zulu'
-          cache: gradle
+
+      - name: Cache Gradle
+        uses: burrunan/gradle-cache-action@v1
+
+      - name: Build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./gradlew build clean
+
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "lts/*"
           cache: 'npm'
-      - name: Setup semantic-release
+
+      - name: Install dependencies
         run: npm install
+
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          fingerprint: ${{ env.GPG_FINGERPRINT }}
+
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}

.github/workflows/update_documentation.yml

@@ -11,7 +11,7 @@ jobs:
     name: Dispatch event to documentation repository
     if: github.ref == 'refs/heads/main'
     steps:
-      - uses: peter-evans/repository-dispatch@v2
+      - uses: peter-evans/repository-dispatch@v3
         with:
           token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
           repository: revanced/revanced-documentation

.gitignore

@@ -119,4 +119,7 @@ node_modules/
 
 # ReVanced CLI
 revanced-cache/
-options.toml
+options.toml
+
+# Generated by an Android project (such as ReVanced Integrations)
+local.properties

.releaserc

@@ -10,7 +10,7 @@
     [
       "@semantic-release/commit-analyzer", {
         "releaseRules": [
-          { "type": "build", "scope": "revanced-patcher", "release": "patch" }
+          { "type": "build", "scope": "Needs bump", "release": "patch" }
         ]
       }
     ],
@@ -31,7 +31,7 @@
       {
         "assets": [
           {
-            "path": "build/libs/*all.jar"
+            "path": "build/libs/*-all*"
           }
         ],
         successComment: false

CONTRIBUTING.md

@@ -0,0 +1,98 @@
+<p align="center">
+  <picture>
+    <source
+      width="256px"
+      media="(prefers-color-scheme: dark)"
+      srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
+    >
+    <img 
+      width="256px"
+      src="assets/revanced-headline/revanced-headline-vertical-light.svg"
+    >
+  </picture>
+  <br>
+  <a href="https://revanced.app/">
+     <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
+         <img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
+     </picture>
+   </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">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+           <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://reddit.com/r/revancedapp">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+           <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://t.me/app_revanced">
+      <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+         <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+      </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://x.com/revancedapp">
+      <picture>
+         <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+         <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+      </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://www.youtube.com/@ReVanced">
+      <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+         <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+     </picture>
+   </a>
+   <br>
+   <br>
+   Continuing the legacy of Vanced
+</p>
+
+# 👋 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,107 @@
+<p align="center">
+  <picture>
+    <source
+      width="256px"
+      media="(prefers-color-scheme: dark)"
+      srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
+    >
+    <img 
+      width="256px"
+      src="assets/revanced-headline/revanced-headline-vertical-light.svg"
+    >
+  </picture>
+  <br>
+  <a href="https://revanced.app/">
+     <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
+         <img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
+     </picture>
+   </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">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+           <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://reddit.com/r/revancedapp">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+           <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://t.me/app_revanced">
+      <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+         <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+      </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://x.com/revancedapp">
+      <picture>
+         <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+         <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+      </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://www.youtube.com/@ReVanced">
+      <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+         <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+     </picture>
+   </a>
+   <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 that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.
+
+## 💪 Features
+
+Some of the features ReVanced CLI provides are:
+
+- 💉 **Patch apps**: Harness ReVanced Patcher to patch Android apps
+- 💾 **Install and uninstall apps**: Install and uninstall Apps via ADB,
+  using the Android package manager, or by mounting using root permissions
+- 📃 **List patches from patch bundles**: List available patches, compatible packages, and versions
+- 💪 **Flexibility and functionality**: Apply any combination of patches to any version of Android apps
+
+## 🔽 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
+
+To build a ReVanced CLI, you can follow the [documentation](/docs).
+
+### 📃 Documentation
+
+You can find the documentation of ReVanced CLI [here](/docs).
+
+## 📜 Licence
+
+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.
+Any modifications to ReVanced CLI must also be made available under the GPL, along with build & install instructions.

build.gradle.kts

@@ -1,41 +1,50 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
-    kotlin("jvm") version "1.8.10"
-    id("com.github.johnrengelman.shadow") version "7.1.2"
+    alias(libs.plugins.kotlin)
+    alias(libs.plugins.shadow)
+    application
+    `maven-publish`
+    signing
 }
 
 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")
+application {
+    mainClass = "app.revanced.cli.command.MainCommandKt"
+}
 
 repositories {
     mavenCentral()
     mavenLocal()
+    google()
     maven {
-        url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
+        // A repository must be speficied for some reason. "registry" is a dummy.
+        url = uri("https://maven.pkg.github.com/revanced/registry")
         credentials {
-            username = githubUsername
-            password = githubPassword
+            username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
+            password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
         }
     }
-    maven { url = uri("https://jitpack.io") }
-    google()
 }
 
 dependencies {
-    implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.20-RC")
+    implementation(libs.revanced.patcher)
+    implementation(libs.revanced.library)
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.picocli)
 
-    implementation("app.revanced:revanced-patcher:9.0.0")
-    implementation("info.picocli:picocli:4.7.1")
-    implementation("com.github.revanced:jadb:2531a28109") // updated fork
-    implementation("com.android.tools.build:apksig:8.1.0-alpha09")
-    implementation("org.bouncycastle:bcpkix-jdk15on:1.70")
-    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.14.+")
-    testImplementation("org.jetbrains.kotlin:kotlin-test:1.8.20-RC")
+    testImplementation(libs.kotlin.test)
 }
 
 kotlin {
-    jvmToolchain(11)
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
+    }
+}
+
+java {
+    targetCompatibility = JavaVersion.VERSION_11
 }
 
 tasks {
@@ -45,25 +54,42 @@ tasks {
             events("PASSED", "SKIPPED", "FAILED")
         }
     }
-    build {
-        dependsOn(shadowJar)
+
+    processResources {
+        expand("projectVersion" to project.version)
     }
+
     shadowJar {
-        manifest {
-            attributes("Main-Class" to "app.revanced.cli.main.MainKt")
-        }
         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)
+
+    publish {
+        dependsOn(shadowJar)
     }
 }
+
+// Needed by gradle-semantic-release-plugin.
+// Tracking: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
+
+// The maven-publish is also necessary to make the signing plugin work.
+publishing {
+    repositories {
+        mavenLocal()
+    }
+
+    publications {
+        create<MavenPublication>("revanced-cli-publication") {
+            from(components["java"])
+        }
+    }
+}
+
+signing {
+    useGpgCmd()
+
+    sign(publishing.publications["revanced-cli-publication"])
+}

docs/0_prerequisites.md

@@ -1,15 +1,15 @@
 # 💼 Prerequisites
 
-To use ReVanced CLI, you will need to fulfill certain requirements.
+To use ReVanced CLI, you will need to fulfill specific requirements.
 
 ## 🤝 Requirements
 
-- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to deploy the patched APK file on your device
+- 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/))
+- [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)
-- Java SDK 17 or higher (Azul JDK or OpenJDK)
 
 ## ⏭️ Whats next
 
-The next section will show, how to use [ReVanced CLI](https://github.com/revanced/revanced-cli).
+The following section will show you how to use ReVanced CLI.
 
-Continue: [🛠️ Using ReVanced CLI](1_usage.md)
+Continue: [🛠️ Using ReVanced CLI](1_usage.md)

docs/1_usage.md

@@ -1,74 +1,129 @@
 # 🛠️ Using ReVanced CLI
 
-Learn how to ReVanced CLI.
+Learn how to use ReVanced CLI.
 
-## ⚡ Setup (optional)
+## 🔨 Usage
 
-1. Make sure your device is connected
+ReVanced CLI is divided into the following fundamental commands:
 
-   ```bash
-   adb shell exit
-   ```
-
-   If you plan to use the root variant, check if you have root access
-
-   ```bash
-   adb shell su -c exit
-   ```
-
-2. Copy the ADB device name
-
-   ```bash
-   adb devices
-   ```
-
-## 🔨 ReVanced CLI Usage
-
-- ### Show all available options for 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
 
   ```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 ReVanced CLI without root permissions
+- ### ⚙️ Generate options
+
+  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 \
+  java -jar revanced-cli.jar options \
+   --path options.json \
+   --overwrite \
+   revanced-patches.jar [<patch-bundle> ...]
+  ```
+
+  > **ℹ️ Note**  
+  > A default `options.json` file will be automatically created if it does not exist
+  > without any need for intervention when using the `patch` command.
+
+- ### 💉 Patch an app
+
+  You can patch apps by supplying patch bundles and the app to patch.
+  After patching, ReVanced CLI can install the patched app on your device using two methods:
+
+  > **💡 Tip**  
+  > For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working:
+  >
+  > ```bash
+  > adb shell exit
+  > ```
+  >
+  > If you want to mount the patched app on top of the un-patched app, make sure you have root permissions:
+  >
+  > ```bash
+  > adb shell su -c exit
+  > ```
+
+  > **⚠️ Warning**  
+  > Some patches may require integrations
+  > such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations).
+  > Supply them with the option `--merge`. ReVanced Patcher will automatically determine if they are necessary.
+
+  - #### 👾 Patch an app and install it on your device regularly
+
+    ```bash
+    java -jar revanced-cli.jar patch \
+     --patch-bundle revanced-patches.jar \
+     -d \
+     input.apk
+    ```
+
+  - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions
+
+    > **❗ Caution**  
+    > Ensure that the same app you are patching and mounting over is installed on your device:
+    >
+    > ```bash
+    > adb install app.apk
+    > ```
+
+    ```bash
+    java -jar revanced-cli.jar patch \
+     --patch-bundle revanced-patches.jar \
+     --include "Some patch" \
+     --ii 123 \
+     --exclude "Some other patch" \
+     -d \
+     --mount \
+     app.apk
+    ```
+
+    > **💡 Tip**  
+    > You can use the option `--ii` to include or `--ie` to exclude
+    > patches by their index in relation to supplied patch bundles,
+    > similarly to the option `--include` and `--exclude`.
+    >
+    > This is useful in case two patches have the same name, and you must include or exclude one.  
+    > The patch index is calculated by the position of the patch in the list of patches
+    > from patch bundles supplied using the option `--patch-bundle`.
+    >
+    > You can list all patches with their indices using the command `list-patches`.
+    >
+    > Keep in mind that the indices can change based on the order of the patch bundles supplied,
+    > as well if the patch bundles are updated because patches can be added or removed.
+
+- ### 🗑️ Uninstall an app
+
+  ```bash
+  java -jar revanced-cli.jar utility uninstall \
+   --package-name <package-name> \
+   [<device-serial>]
+  ```
+
+  > **💡 Tip**  
+  > You can unmount an APK file
+  > by adding the option `--unmount`.
+
+- ### ️ 📦 Install an app
+
+  ```bash
+  java -jar revanced-cli.jar utility install \
    -a input.apk \
-   -o patched-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 \
-      -d device-name \
-      -o patched-output.apk \
-      -b revanced-patches.jar \
-      -e vanced-microg-support \
-      --mount
-  ```
-
-> **Note**:
->
-> - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you can exclude
-    the `vanced-microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
-    option `-e vanced-microg-support` when mounting for example.
->
-> - 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`.
-    > The integrations will be merged, if necessary automatically, if supplied.
->
-> - If you supplied a device with the option `-d`, the patched application will be automatically installed on the
-    device.
+  > **💡 Tip**  
+  > You can mount an APK file
+  > by supplying the app's package name to mount the supplied APK file over the option `-mount`.

docs/2_building.md

@@ -0,0 +1,26 @@
+# 🔨️ Building
+
+Build ReVanced CLI from source.
+
+## 📝 Requirements
+
+- Java Development Kit 11 (Azul Zulu JRE or OpenJDK)
+
+## 🏗️ Building
+
+To build ReVanced CLI, follow these steps:
+
+1. Clone the repository:
+
+   ```bash
+   git clone git@github.com:ReVanced/revanced-cli.git
+   cd revanced-cli
+   ```
+
+2. Build the project:
+
+   ```bash
+    ./gradlew build
+   ```
+
+After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli-<version>-all.jar`.

docs/README.md

@@ -1,8 +1,9 @@
 # 💻 Documentation and guides of ReVanced CLI
 
-This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli).
+This documentation contains topics around [ReVanced CLI](https://github.com/revanced/revanced-cli).
 
 ## 📖 Table of contents
 
 1. [💼 Prerequisites](0_prerequisites.md)
 2. [🛠️ Using ReVanced CLI](1_usage.md)
+3. [🔨 Building ReVanced CLI](2_building.md)

gradle.properties

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

gradle/libs.versions.toml

@@ -0,0 +1,18 @@
+[versions]
+shadow = "8.1.1"
+kotlin = "1.9.22"
+kotlinx-coroutines-core = "1.7.3"
+picocli = "4.7.5"
+revanced-patcher = "19.3.1"
+revanced-library = "2.2.1"
+
+[libraries]
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
+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" }
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
+distributionSha256Sum=9631d53cf3e74bfa726893aee1f8994fee4e060c401335946dba2156f440f24c
 zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
+zipStorePath=wrapper/dist

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