├── .editorconfig ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.yml │ ├── config.yml │ └── feature_request.yml ├── config.yml └── workflows │ └── sync.yml ├── .gitignore ├── .releaserc ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── assets ├── revanced-headline │ ├── revanced-headline-vertical-dark.svg │ └── revanced-headline-vertical-light.svg └── revanced-logo │ └── revanced-logo.svg ├── build.gradle.kts ├── docs ├── 0_prerequisites.md ├── 1_usage.md ├── 2_building.md └── README.md ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── lib.patch ├── package-lock.json ├── package.json ├── settings.gradle.kts └── src └── main ├── kotlin └── app │ └── revanced │ └── cli │ └── command │ ├── ListCompatibleVersions.kt │ ├── ListPatchesCommand.kt │ ├── MainCommand.kt │ ├── OptionsCommand.kt │ ├── PatchCommand.kt │ └── utility │ ├── InstallCommand.kt │ ├── UninstallCommand.kt │ └── UtilityCommand.kt └── resources └── app └── revanced └── cli └── version.properties /.editorconfig: -------------------------------------------------------------------------------- 1 | [*.{kt,kts}] 2 | ktlint_code_style = intellij_idea 3 | ktlint_standard_no-wildcard-imports = disabled -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # 2 | # https://help.github.com/articles/dealing-with-line-endings/ 3 | # 4 | # Linux start script should use lf 5 | /gradlew text eol=lf 6 | 7 | # These are Windows script files and should use crlf 8 | *.bat text eol=crlf 9 | 10 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug report 2 | description: Report a bug or an issue. 3 | title: 'bug: ' 4 | labels: ['Bug report'] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 |

10 | 11 | 16 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 27 |     28 | 29 | 30 | 31 | 32 | 33 |     34 | 35 | 36 | 37 | 38 | 39 |     40 | 41 | 42 | 43 | 44 | 45 |     46 | 47 | 48 | 49 | 50 | 51 |     52 | 53 | 54 | 55 | 56 | 57 |     58 | 59 | 60 | 61 | 62 | 63 | 64 |
65 |
66 | Continuing the legacy of Vanced 67 |

68 | 69 | # ReVanced CLI bug report 70 | 71 | Before creating a new bug report, please keep the following in mind: 72 | 73 | - **Do not submit a duplicate bug report**: You can review existing bug reports [here](https://github.com/ReVanced/revanced-cli/labels/Bug%20report). 74 | - **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). 75 | - **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). 76 | - type: textarea 77 | attributes: 78 | label: Bug description 79 | description: | 80 | - Describe your bug in detail 81 | - Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...) 82 | - Add images and videos if possible 83 | - List used patches if applicable 84 | validations: 85 | required: true 86 | - type: textarea 87 | attributes: 88 | label: Error logs 89 | description: Exceptions can be captured by running `logcat | grep AndroidRuntime` in a shell. 90 | render: shell 91 | - type: textarea 92 | attributes: 93 | label: Solution 94 | description: If applicable, add a possible solution to the bug. 95 | - type: textarea 96 | attributes: 97 | label: Additional context 98 | description: Add additional context here. 99 | - type: checkboxes 100 | id: acknowledgements 101 | attributes: 102 | label: Acknowledgements 103 | description: Your bug report will be closed if you don't follow the checklist below. 104 | options: 105 | - label: This issue is not a duplicate of an existing bug report. 106 | required: true 107 | - label: I have chosen an appropriate title. 108 | required: true 109 | - label: All requested information has been provided properly. 110 | required: true 111 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: 🗨 Discussions 4 | url: https://github.com/revanced/revanced-suggestions/discussions 5 | about: Have something unspecific to ReVanced CLI in mind? Search for or start a new discussion! -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: ⭐ Feature request 2 | description: Create a detailed request for a new feature. 3 | title: 'feat: ' 4 | labels: ['Feature request'] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 |

10 | 11 | 16 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 27 |     28 | 29 | 30 | 31 | 32 | 33 |     34 | 35 | 36 | 37 | 38 | 39 |     40 | 41 | 42 | 43 | 44 | 45 |     46 | 47 | 48 | 49 | 50 | 51 |     52 | 53 | 54 | 55 | 56 | 57 |     58 | 59 | 60 | 61 | 62 | 63 | 64 |
65 |
66 | Continuing the legacy of Vanced 67 |

68 | 69 | # ReVanced CLI feature request 70 | 71 | Before creating a new feature request, please keep the following in mind: 72 | 73 | - **Do not submit a duplicate feature request**: You can review existing feature requests [here](https://github.com/ReVanced/revanced-cli//labels/Feature%20request). 74 | - **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). 75 | - **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). 76 | - type: textarea 77 | attributes: 78 | label: Feature description 79 | description: | 80 | - Describe your feature in detail 81 | - Add images, videos, links, examples, references, etc. if possible 82 | - Add the target application name in case you request a new patch 83 | - type: textarea 84 | attributes: 85 | label: Motivation 86 | description: | 87 | A strong motivation is necessary for a feature request to be considered. 88 | 89 | - Why should this feature be implemented? 90 | - What is the explicit use case? 91 | - What are the benefits? 92 | - What makes this feature important? 93 | validations: 94 | required: true 95 | - type: checkboxes 96 | id: acknowledgements 97 | attributes: 98 | label: Acknowledgements 99 | description: Your feature request will be closed if you don't follow the checklist below. 100 | options: 101 | - label: This issue is not a duplicate of an existing feature request. 102 | required: true 103 | - label: I have chosen an appropriate title. 104 | required: true 105 | - label: All requested information has been provided properly. 106 | required: true 107 | -------------------------------------------------------------------------------- /.github/config.yml: -------------------------------------------------------------------------------- 1 | firstPRMergeComment: > 2 | Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) to receive a role for your contribution. 3 | -------------------------------------------------------------------------------- /.github/workflows/sync.yml: -------------------------------------------------------------------------------- 1 | name: Sync upstream 2 | on: 3 | workflow_call: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: "0 15 * * *" 7 | 8 | jobs: 9 | check: 10 | permissions: write-all 11 | 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v4 16 | with: 17 | fetch-depth: 0 18 | token: ${{ secrets.GH_TOKEN }} 19 | 20 | - name: sync 21 | id: sync 22 | shell: bash 23 | run: | 24 | git config --global user.name 'j-hc' 25 | git config --global user.email 'j-hc@users.noreply.github.com' 26 | git remote add upstream https://github.com/revanced/revanced-cli 27 | git fetch upstream 28 | 29 | if ! git show -s --format=%s upstream/main | grep -q -- '-dev'; then 30 | C=$(git rev-list --left-right --count origin/main...remotes/upstream/main | awk '{print $2}') 31 | echo "ahead $C commits." 32 | if [ "$C" -gt 1 ]; then 33 | echo "rebase" 34 | git rebase upstream/main 35 | git tag -d $(git tag) 36 | git fetch upstream --tags -f 37 | git push -f 38 | git push --tags -f 39 | echo "SHOULD_BUILD=1" >> $GITHUB_OUTPUT 40 | else 41 | echo "in sync" 42 | echo "SHOULD_BUILD=0" >> $GITHUB_OUTPUT 43 | fi 44 | else 45 | echo "dev" 46 | echo "SHOULD_BUILD=0" >> $GITHUB_OUTPUT 47 | fi 48 | 49 | - name: build 50 | id: build 51 | if: ${{ steps.sync.outputs.SHOULD_BUILD == 1 }} 52 | run: | 53 | T=$(git tag --sort=creatordate | tail -1) 54 | LT=${T: -1} 55 | LT=$((LT + 1)) 56 | RT=${T%?}${LT} 57 | sed -i "s/^version =.*/version = ${RT:1}/g" gradle.properties 58 | LIB_T=$(grep 'revanced-library = "' gradle/libs.versions.toml | awk -F '"' '{print $2}') 59 | git clone https://github.com/revanced/revanced-library 60 | cd revanced-library 61 | git checkout v${LIB_T} 62 | git apply ../lib.patch 63 | GITHUB_ACTOR=${{ secrets.GH_GRADLE_ACTOR }} GITHUB_TOKEN=${{ secrets.GH_GRADLE_TOKEN }} ./gradlew publishToMavenLocal 64 | cd .. 65 | GITHUB_ACTOR=${{ secrets.GH_GRADLE_ACTOR }} GITHUB_TOKEN=${{ secrets.GH_GRADLE_TOKEN }} ./gradlew build 66 | echo "RT=$RT" >> $GITHUB_OUTPUT 67 | 68 | - name: Release 69 | if: ${{ steps.sync.outputs.SHOULD_BUILD == 1 }} 70 | uses: svenstaro/upload-release-action@v2 71 | with: 72 | repo_token: ${{ secrets.GITHUB_TOKEN }} 73 | release_name: ${{ steps.build.outputs.RT }} 74 | tag: ${{ steps.build.outputs.RT }} 75 | file: build/libs/*-all.jar 76 | file_glob: true 77 | overwrite: true 78 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Java template 2 | # Compiled class file 3 | *.class 4 | 5 | # Log file 6 | *.log 7 | 8 | # BlueJ files 9 | *.ctxt 10 | 11 | # Mobile Tools for Java (J2ME) 12 | .mtj.tmp/ 13 | 14 | # Package Files # 15 | *.jar 16 | *.war 17 | *.nar 18 | *.ear 19 | *.zip 20 | *.tar.gz 21 | *.rar 22 | 23 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 24 | hs_err_pid* 25 | 26 | ### JetBrains template 27 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 28 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 29 | 30 | # User-specific stuff 31 | .idea/**/workspace.xml 32 | .idea/**/tasks.xml 33 | .idea/**/usage.statistics.xml 34 | .idea/**/dictionaries 35 | .idea/**/shelf 36 | 37 | # Generated files 38 | .idea/**/contentModel.xml 39 | 40 | # Sensitive or high-churn files 41 | .idea/**/dataSources/ 42 | .idea/**/dataSources.ids 43 | .idea/**/dataSources.local.xml 44 | .idea/**/sqlDataSources.xml 45 | .idea/**/dynamic.xml 46 | .idea/**/uiDesigner.xml 47 | .idea/**/dbnavigator.xml 48 | 49 | # Gradle 50 | .idea/**/gradle.xml 51 | .idea/**/libraries 52 | 53 | # Gradle and Maven with auto-import 54 | # When using Gradle or Maven with auto-import, you should exclude module files, 55 | # since they will be recreated, and may cause churn. Uncomment if using 56 | # auto-import. 57 | .idea/artifacts 58 | .idea/compiler.xml 59 | .idea/jarRepositories.xml 60 | .idea/modules.xml 61 | .idea/*.iml 62 | .idea/modules 63 | *.iml 64 | *.ipr 65 | 66 | # CMake 67 | cmake-build-*/ 68 | 69 | # Mongo Explorer plugin 70 | .idea/**/mongoSettings.xml 71 | 72 | # File-based project format 73 | *.iws 74 | 75 | # IntelliJ 76 | out/ 77 | .idea 78 | 79 | # mpeltonen/sbt-idea plugin 80 | .idea_modules/ 81 | 82 | # JIRA plugin 83 | atlassian-ide-plugin.xml 84 | 85 | # Cursive Clojure plugin 86 | .idea/replstate.xml 87 | 88 | # Crashlytics plugin (for Android Studio and IntelliJ) 89 | com_crashlytics_export_strings.xml 90 | crashlytics.properties 91 | crashlytics-build.properties 92 | fabric.properties 93 | 94 | # Editor-based Rest Client 95 | .idea/httpRequests 96 | 97 | # Android studio 3.1+ serialized cache file 98 | .idea/caches/build_file_checksums.ser 99 | 100 | ### Gradle template 101 | .gradle 102 | **/build/ 103 | !src/**/build/ 104 | 105 | # Ignore Gradle GUI config 106 | gradle-app.setting 107 | 108 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 109 | !gradle-wrapper.jar 110 | 111 | # Cache of project 112 | .gradletasknamecache 113 | 114 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 115 | # gradle/wrapper/gradle-wrapper.properties 116 | 117 | # Dependency directories 118 | node_modules/ 119 | 120 | # ReVanced CLI 121 | revanced-cache/ 122 | options.toml 123 | 124 | # Generated by an Android project (such as ReVanced Integrations) 125 | local.properties -------------------------------------------------------------------------------- /.releaserc: -------------------------------------------------------------------------------- 1 | { 2 | "branches": [ 3 | "main", 4 | { 5 | "name": "dev", 6 | "prerelease": true 7 | } 8 | ], 9 | "plugins": [ 10 | [ 11 | "@semantic-release/commit-analyzer", { 12 | "releaseRules": [ 13 | { "type": "build", "scope": "Needs bump", "release": "patch" } 14 | ] 15 | } 16 | ], 17 | "@semantic-release/release-notes-generator", 18 | "@semantic-release/changelog", 19 | "gradle-semantic-release-plugin", 20 | [ 21 | "@semantic-release/git", 22 | { 23 | "assets": [ 24 | "CHANGELOG.md", 25 | "gradle.properties" 26 | ] 27 | } 28 | ], 29 | [ 30 | "@semantic-release/github", 31 | { 32 | "assets": [ 33 | { 34 | "path": "build/libs/*-all*" 35 | } 36 | ], 37 | successComment: false 38 | } 39 | ], 40 | [ 41 | "@saithodev/semantic-release-backmerge", 42 | { 43 | backmergeBranches: [{"from": "main", "to": "dev"}], 44 | clearWorkspace: true 45 | } 46 | ] 47 | ] 48 | } 49 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 8 | 12 | 13 |
14 | 15 | 16 | 17 | 18 | 19 |     20 | 21 | 22 | 23 | 24 | 25 |     26 | 27 | 28 | 29 | 30 | 31 |     32 | 33 | 34 | 35 | 36 | 37 |     38 | 39 | 40 | 41 | 42 | 43 |     44 | 45 | 46 | 47 | 48 | 49 |     50 | 51 | 52 | 53 | 54 | 55 | 56 |
57 |
58 | Continuing the legacy of Vanced 59 |

60 | 61 | # 👋 Contribution guidelines 62 | 63 | This document describes how to contribute to ReVanced CLI. 64 | 65 | ## 📖 Resources to help you get started 66 | 67 | - The [documentation](/docs) explains how to use ReVanced CLI 68 | - [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on 69 | - [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests 70 | 71 | ## 🙏 Submitting a feature request 72 | 73 | Features can be requested by opening an issue using the 74 | [Feature request issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+). 75 | 76 | > **Note** 77 | > Requests can be accepted or rejected at the discretion of maintainers of ReVanced CLI. 78 | > Good motivation has to be provided for a request to be accepted. 79 | 80 | ## 🐞 Submitting a bug report 81 | 82 | If you encounter a bug while using ReVanced CLI, open an issue using the 83 | [Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+). 84 | 85 | ## 📝 How to contribute 86 | 87 | 1. Before contributing, it is recommended to open an issue to discuss your change 88 | with the maintainers of ReVanced CLI. This will help you determine whether your change is acceptable 89 | and whether it is worth your time to implement it 90 | 2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev` 91 | 3. Commit your changes 92 | 4. Submit a pull request to the `dev` branch of the repository and reference issues 93 | that your pull request closes in the description of your pull request 94 | 5. Our team will review your pull request and provide feedback. Once your pull request is approved, 95 | it will be merged into the `dev` branch and will be included in the next release of ReVanced CLI 96 | 97 | ❤️ Thank you for considering contributing to ReVanced CLI, 98 | ReVanced 99 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 8 | 12 | 13 |
14 | 15 | 16 | 17 | 18 | 19 |     20 | 21 | 22 | 23 | 24 | 25 |     26 | 27 | 28 | 29 | 30 | 31 |     32 | 33 | 34 | 35 | 36 | 37 |     38 | 39 | 40 | 41 | 42 | 43 |     44 | 45 | 46 | 47 | 48 | 49 |     50 | 51 | 52 | 53 | 54 | 55 | 56 |
57 |
58 | Continuing the legacy of Vanced 59 |

60 | 61 | # 💻 ReVanced CLI 62 | 63 | ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-cli/release.yml) 64 | ![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) 65 | 66 | Command line application to use ReVanced. 67 | 68 | ## ❓ About 69 | 70 | ReVanced CLI is a command line application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps. 71 | 72 | ## 💪 Features 73 | 74 | Some of the features ReVanced CLI provides are: 75 | 76 | - 💉 **Patch apps**: Harness ReVanced Patcher to patch Android apps 77 | - 💾 **Install and uninstall apps**: Install and uninstall Apps via ADB, 78 | using the Android package manager, or by mounting using root permissions 79 | - 📃 **List patches from patch bundles**: List available patches, compatible packages, and versions 80 | - 💪 **Flexibility and functionality**: Apply any combination of patches to any version of Android apps 81 | 82 | ## 🔽 Download 83 | 84 | You can download the most recent version of ReVanced CLI from 85 | [here](https://github.com/ReVanced/revanced-cli/releases/latest). 86 | Learn how to use ReVanced CLI by following the [documentation](/docs). 87 | 88 | ## 📚 Everything else 89 | 90 | ### 📙 Contributing 91 | 92 | Thank you for considering contributing to ReVanced CLI. 93 | You can find the contribution guidelines [here](CONTRIBUTING.md). 94 | 95 | ### 🛠️ Building 96 | 97 | To build a ReVanced CLI, you can follow the [documentation](/docs). 98 | 99 | ### 📃 Documentation 100 | 101 | You can find the documentation of ReVanced CLI [here](/docs). 102 | 103 | ## 📜 Licence 104 | 105 | ReVanced CLI is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information. 106 | [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. 107 | Any modifications to ReVanced CLI must also be made available under the GPL, along with build & install instructions. 108 | -------------------------------------------------------------------------------- /assets/revanced-headline/revanced-headline-vertical-dark.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /assets/revanced-headline/revanced-headline-vertical-light.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /assets/revanced-logo/revanced-logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | import org.jetbrains.kotlin.gradle.dsl.JvmTarget 2 | 3 | plugins { 4 | alias(libs.plugins.kotlin) 5 | alias(libs.plugins.shadow) 6 | application 7 | `maven-publish` 8 | signing 9 | } 10 | 11 | group = "app.revanced" 12 | 13 | application { 14 | mainClass = "app.revanced.cli.command.MainCommandKt" 15 | } 16 | 17 | repositories { 18 | mavenCentral() 19 | mavenLocal() 20 | google() 21 | maven { 22 | // A repository must be speficied for some reason. "registry" is a dummy. 23 | url = uri("https://maven.pkg.github.com/revanced/registry") 24 | credentials { 25 | username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR") 26 | password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN") 27 | } 28 | } 29 | } 30 | 31 | dependencies { 32 | implementation(libs.revanced.patcher) 33 | implementation(libs.revanced.library) 34 | implementation(libs.kotlinx.coroutines.core) 35 | implementation(libs.picocli) 36 | 37 | testImplementation(libs.kotlin.test) 38 | } 39 | 40 | kotlin { 41 | compilerOptions { 42 | jvmTarget.set(JvmTarget.JVM_11) 43 | } 44 | } 45 | 46 | java { 47 | targetCompatibility = JavaVersion.VERSION_11 48 | } 49 | 50 | tasks { 51 | test { 52 | useJUnitPlatform() 53 | testLogging { 54 | events("PASSED", "SKIPPED", "FAILED") 55 | } 56 | } 57 | 58 | processResources { 59 | expand("projectVersion" to project.version) 60 | } 61 | 62 | shadowJar { 63 | minimize { 64 | exclude(dependency("org.jetbrains.kotlin:.*")) 65 | exclude(dependency("org.bouncycastle:.*")) 66 | exclude(dependency("app.revanced:.*")) 67 | } 68 | } 69 | 70 | publish { 71 | dependsOn(shadowJar) 72 | } 73 | } 74 | 75 | // Needed by gradle-semantic-release-plugin. 76 | // Tracking: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435 77 | 78 | // The maven-publish is also necessary to make the signing plugin work. 79 | -------------------------------------------------------------------------------- /docs/0_prerequisites.md: -------------------------------------------------------------------------------- 1 | # 💼 Prerequisites 2 | 3 | To use ReVanced CLI, you will need to fulfill specific requirements. 4 | 5 | ## 🤝 Requirements 6 | 7 | - 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/)) 8 | - [Android Debug Bridge (ADB)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device 9 | - An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7) 10 | 11 | ## ⏭️ Whats next 12 | 13 | The following section will show you how to use ReVanced CLI. 14 | 15 | Continue: [🛠️ Using ReVanced CLI](1_usage.md) 16 | -------------------------------------------------------------------------------- /docs/1_usage.md: -------------------------------------------------------------------------------- 1 | # 🛠️ Using ReVanced CLI 2 | 3 | Learn how to use ReVanced CLI. 4 | 5 | ## 🔨 Usage 6 | 7 | ReVanced CLI is divided into the following fundamental commands: 8 | 9 | - ### 🚀 Show all available options for ReVanced CLI 10 | 11 | ```bash 12 | java -jar revanced-cli.jar -h 13 | ``` 14 | 15 | - ### 📃 List patches 16 | 17 | ```bash 18 | java -jar revanced-cli.jar list-patches \ 19 | --with-packages \ 20 | --with-versions \ 21 | --with-options \ 22 | revanced-patches.jar [ ...] 23 | ``` 24 | 25 | - ### ⚙️ Generate options 26 | 27 | This will generate an `options.json` file for the patches from a list of supplied patch bundles. 28 | The file can be supplied to ReVanced CLI later on. 29 | 30 | ```bash 31 | java -jar revanced-cli.jar options \ 32 | --path options.json \ 33 | --overwrite \ 34 | revanced-patches.jar [ ...] 35 | ``` 36 | 37 | > **ℹ️ Note** 38 | > A default `options.json` file will be automatically created if it does not exist 39 | > without any need for intervention when using the `patch` command. 40 | 41 | - ### 💉 Patch an app 42 | 43 | You can patch apps by supplying patch bundles and the app to patch. 44 | After patching, ReVanced CLI can install the patched app on your device using two methods: 45 | 46 | > **💡 Tip** 47 | > For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working: 48 | > 49 | > ```bash 50 | > adb shell exit 51 | > ``` 52 | > 53 | > If you want to mount the patched app on top of the un-patched app, make sure you have root permissions: 54 | > 55 | > ```bash 56 | > adb shell su -c exit 57 | > ``` 58 | 59 | > **⚠️ Warning** 60 | > Some patches may require integrations 61 | > such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations). 62 | > Supply them with the option `--merge`. ReVanced Patcher will automatically determine if they are necessary. 63 | 64 | - #### 👾 Patch an app and install it on your device regularly 65 | 66 | ```bash 67 | java -jar revanced-cli.jar patch \ 68 | --patch-bundle revanced-patches.jar \ 69 | -d \ 70 | input.apk 71 | ``` 72 | 73 | - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions 74 | 75 | > **❗ Caution** 76 | > Ensure that the same app you are patching and mounting over is installed on your device: 77 | > 78 | > ```bash 79 | > adb install app.apk 80 | > ``` 81 | 82 | ```bash 83 | java -jar revanced-cli.jar patch \ 84 | --patch-bundle revanced-patches.jar \ 85 | --include "Some patch" \ 86 | --ii 123 \ 87 | --exclude "Some other patch" \ 88 | -d \ 89 | --mount \ 90 | app.apk 91 | ``` 92 | 93 | > **💡 Tip** 94 | > You can use the option `--ii` to include or `--ie` to exclude 95 | > patches by their index in relation to supplied patch bundles, 96 | > similarly to the option `--include` and `--exclude`. 97 | > 98 | > This is useful in case two patches have the same name, and you must include or exclude one. 99 | > The patch index is calculated by the position of the patch in the list of patches 100 | > from patch bundles supplied using the option `--patch-bundle`. 101 | > 102 | > You can list all patches with their indices using the command `list-patches`. 103 | > 104 | > Keep in mind that the indices can change based on the order of the patch bundles supplied, 105 | > as well if the patch bundles are updated because patches can be added or removed. 106 | 107 | - ### 🗑️ Uninstall an app 108 | 109 | ```bash 110 | java -jar revanced-cli.jar utility uninstall \ 111 | --package-name \ 112 | [] 113 | ``` 114 | 115 | > **💡 Tip** 116 | > You can unmount an APK file 117 | > by adding the option `--unmount`. 118 | 119 | - ### ️ 📦 Install an app 120 | 121 | ```bash 122 | java -jar revanced-cli.jar utility install \ 123 | -a input.apk \ 124 | [] 125 | ``` 126 | 127 | > **💡 Tip** 128 | > You can mount an APK file 129 | > by supplying the app's package name to mount the supplied APK file over the option `-mount`. 130 | -------------------------------------------------------------------------------- /docs/2_building.md: -------------------------------------------------------------------------------- 1 | # 🔨️ Building 2 | 3 | Build ReVanced CLI from source. 4 | 5 | ## 📝 Requirements 6 | 7 | - Java Development Kit 11 (Azul Zulu JRE or OpenJDK) 8 | 9 | ## 🏗️ Building 10 | 11 | To build ReVanced CLI, follow these steps: 12 | 13 | 1. Clone the repository: 14 | 15 | ```bash 16 | git clone git@github.com:ReVanced/revanced-cli.git 17 | cd revanced-cli 18 | ``` 19 | 20 | 2. Build the project: 21 | 22 | ```bash 23 | ./gradlew build 24 | ``` 25 | 26 | > [!NOTE] 27 | > If the build fails due to authentication, you may need to authenticate to GitHub Packages. 28 | > Create a PAT with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) and add your token to ~/.gradle/gradle.properties. 29 | > 30 | > Example `gradle.properties` file: 31 | > 32 | > ```properties 33 | > gpr.user = user 34 | > gpr.key = key 35 | > ``` 36 | 37 | After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli--all.jar`. 38 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # 💻 Documentation and guides of ReVanced CLI 2 | 3 | This documentation contains topics around [ReVanced CLI](https://github.com/revanced/revanced-cli). 4 | 5 | ## 📖 Table of contents 6 | 7 | 1. [💼 Prerequisites](0_prerequisites.md) 8 | 2. [🛠️ Using ReVanced CLI](1_usage.md) 9 | 3. [🔨 Building ReVanced CLI](2_building.md) 10 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | org.gradle.parallel = true 2 | org.gradle.caching = true 3 | kotlin.code.style = official 4 | version = 4.6.0 5 | -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | shadow = "8.1.1" 3 | kotlin = "1.9.22" 4 | kotlinx-coroutines-core = "1.7.3" 5 | picocli = "4.7.5" 6 | revanced-patcher = "19.3.1" 7 | revanced-library = "2.3.0" 8 | 9 | [libraries] 10 | kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" } 11 | kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines-core" } 12 | picocli = { module = "info.picocli:picocli", version.ref = "picocli" } 13 | revanced-patcher = { module = "app.revanced:revanced-patcher", version.ref = "revanced-patcher" } 14 | revanced-library = { module = "app.revanced:revanced-library", version.ref = "revanced-library" } 15 | 16 | [plugins] 17 | shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" } 18 | kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/j-hc/revanced-cli/0d4491af8184f0bc772b130a0cc62243fbfdefee/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip 4 | distributionSha256Sum=9631d53cf3e74bfa726893aee1f8994fee4e060c401335946dba2156f440f24c 5 | zipStoreBase=GRADLE_USER_HOME 6 | zipStorePath=wrapper/dist -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 87 | 88 | # Use the maximum available, or set MAX_FD != -1 to use that value. 89 | MAX_FD=maximum 90 | 91 | warn () { 92 | echo "$*" 93 | } >&2 94 | 95 | die () { 96 | echo 97 | echo "$*" 98 | echo 99 | exit 1 100 | } >&2 101 | 102 | # OS specific support (must be 'true' or 'false'). 103 | cygwin=false 104 | msys=false 105 | darwin=false 106 | nonstop=false 107 | case "$( uname )" in #( 108 | CYGWIN* ) cygwin=true ;; #( 109 | Darwin* ) darwin=true ;; #( 110 | MSYS* | MINGW* ) msys=true ;; #( 111 | NONSTOP* ) nonstop=true ;; 112 | esac 113 | 114 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 115 | 116 | 117 | # Determine the Java command to use to start the JVM. 118 | if [ -n "$JAVA_HOME" ] ; then 119 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 120 | # IBM's JDK on AIX uses strange locations for the executables 121 | JAVACMD=$JAVA_HOME/jre/sh/java 122 | else 123 | JAVACMD=$JAVA_HOME/bin/java 124 | fi 125 | if [ ! -x "$JAVACMD" ] ; then 126 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 127 | 128 | Please set the JAVA_HOME variable in your environment to match the 129 | location of your Java installation." 130 | fi 131 | else 132 | JAVACMD=java 133 | if ! command -v java >/dev/null 2>&1 134 | then 135 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 136 | 137 | Please set the JAVA_HOME variable in your environment to match the 138 | location of your Java installation." 139 | fi 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 147 | # shellcheck disable=SC3045 148 | MAX_FD=$( ulimit -H -n ) || 149 | warn "Could not query maximum file descriptor limit" 150 | esac 151 | case $MAX_FD in #( 152 | '' | soft) :;; #( 153 | *) 154 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 155 | # shellcheck disable=SC3045 156 | ulimit -n "$MAX_FD" || 157 | warn "Could not set maximum file descriptor limit to $MAX_FD" 158 | esac 159 | fi 160 | 161 | # Collect all arguments for the java command, stacking in reverse order: 162 | # * args from the command line 163 | # * the main class name 164 | # * -classpath 165 | # * -D...appname settings 166 | # * --module-path (only if needed) 167 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 168 | 169 | # For Cygwin or MSYS, switch paths to Windows format before running java 170 | if "$cygwin" || "$msys" ; then 171 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 172 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 173 | 174 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 175 | 176 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 177 | for arg do 178 | if 179 | case $arg in #( 180 | -*) false ;; # don't mess with options #( 181 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 182 | [ -e "$t" ] ;; #( 183 | *) false ;; 184 | esac 185 | then 186 | arg=$( cygpath --path --ignore --mixed "$arg" ) 187 | fi 188 | # Roll the args list around exactly as many times as the number of 189 | # args, so each arg winds up back in the position where it started, but 190 | # possibly modified. 191 | # 192 | # NB: a `for` loop captures its iteration list before it begins, so 193 | # changing the positional parameters here affects neither the number of 194 | # iterations, nor the values presented in `arg`. 195 | shift # remove old arg 196 | set -- "$@" "$arg" # push replacement arg 197 | done 198 | fi 199 | 200 | 201 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 202 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 203 | 204 | # Collect all arguments for the java command; 205 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 206 | # shell script including quotes and variable substitutions, so put them in 207 | # double quotes to make sure that they get re-expanded; and 208 | # * put everything else in single quotes, so that it's not re-expanded. 209 | 210 | set -- \ 211 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 212 | -classpath "$CLASSPATH" \ 213 | org.gradle.wrapper.GradleWrapperMain \ 214 | "$@" 215 | 216 | # Stop when "xargs" is not available. 217 | if ! command -v xargs >/dev/null 2>&1 218 | then 219 | die "xargs is not available" 220 | fi 221 | 222 | # Use "xargs" to parse quoted args. 223 | # 224 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 225 | # 226 | # In Bash we could simply go: 227 | # 228 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 229 | # set -- "${ARGS[@]}" "$@" 230 | # 231 | # but POSIX shell has neither arrays nor command substitution, so instead we 232 | # post-process each arg (as a line of input to sed) to backslash-escape any 233 | # character that might be a shell metacharacter, then use eval to reverse 234 | # that process (while maintaining the separation between arguments), and wrap 235 | # the whole thing up as a single "set" statement. 236 | # 237 | # This will of course break if any of these variables contains a newline or 238 | # an unmatched quote. 239 | # 240 | 241 | eval "set -- $( 242 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 243 | xargs -n1 | 244 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 245 | tr '\n' ' ' 246 | )" '"$@"' 247 | 248 | exec "$JAVACMD" "$@" 249 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /lib.patch: -------------------------------------------------------------------------------- 1 | diff --git a/build.gradle.kts b/build.gradle.kts 2 | index 0de3754..43994d2 100644 3 | --- a/build.gradle.kts 4 | +++ b/build.gradle.kts 5 | @@ -106,7 +106,3 @@ publishing { 6 | } 7 | } 8 | 9 | -signing { 10 | - useGpgCmd() 11 | - sign(publishing.publications["revanced-library-publication"]) 12 | -} 13 | diff --git a/src/main/kotlin/app/revanced/library/ApkUtils.kt b/src/main/kotlin/app/revanced/library/ApkUtils.kt 14 | index b56c62c..6737d3f 100644 15 | --- a/src/main/kotlin/app/revanced/library/ApkUtils.kt 16 | +++ b/src/main/kotlin/app/revanced/library/ApkUtils.kt 17 | @@ -50,7 +50,7 @@ object ApkUtils { 18 | * 19 | * @param apkFile The file to apply the patched files to. 20 | */ 21 | - fun PatcherResult.applyTo(apkFile: File) { 22 | + fun PatcherResult.applyTo(apkFile: File, ripLibs: Array) { 23 | ZFile.openReadWrite(apkFile, zFileOptions).use { targetApkZFile -> 24 | dexFiles.forEach { dexFile -> 25 | targetApkZFile.add(dexFile.name, dexFile.stream) 26 | @@ -86,6 +86,10 @@ object ApkUtils { 27 | }.forEach(StoredEntry::delete) 28 | } 29 | } 30 | + if (ripLibs.isNotEmpty()) { 31 | + logger.info("Ripping selected native libs") 32 | + targetApkZFile.entries().filter { entry -> ripLibs.any { entry.centralDirectoryHeader.name.startsWith("lib/$it/") } }.forEach(StoredEntry::delete) 33 | + } 34 | 35 | logger.info("Aligning APK") 36 | 37 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "devDependencies": { 3 | "@saithodev/semantic-release-backmerge": "^4.0.1", 4 | "@semantic-release/changelog": "^6.0.3", 5 | "@semantic-release/git": "^10.0.1", 6 | "gradle-semantic-release-plugin": "^1.9.1", 7 | "semantic-release": "^23.0.2" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "revanced-cli" 2 | 3 | buildCache { 4 | local { 5 | isEnabled = "CI" !in System.getenv() 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/ListCompatibleVersions.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command 2 | 3 | import app.revanced.library.PackageName 4 | import app.revanced.library.PatchUtils 5 | import app.revanced.library.VersionMap 6 | import app.revanced.patcher.PatchBundleLoader 7 | import picocli.CommandLine 8 | import java.io.File 9 | import java.util.logging.Logger 10 | 11 | @CommandLine.Command( 12 | name = "list-versions", 13 | description = [ 14 | "List the most common compatible versions of apps that are compatible " + 15 | "with the patches in the supplied patch bundles.", 16 | ], 17 | ) 18 | internal class ListCompatibleVersions : Runnable { 19 | private val logger = Logger.getLogger(ListCompatibleVersions::class.java.name) 20 | 21 | @CommandLine.Parameters( 22 | description = ["Paths to patch bundles."], 23 | arity = "1..*", 24 | ) 25 | private lateinit var patchBundles: Array 26 | 27 | @CommandLine.Option( 28 | names = ["-f", "--filter-package-names"], 29 | description = ["Filter patches by package name."], 30 | ) 31 | private var packageNames: Set? = null 32 | 33 | @CommandLine.Option( 34 | names = ["-u", "--count-unused-patches"], 35 | description = ["Count patches that are not used by default."], 36 | showDefaultValue = CommandLine.Help.Visibility.ALWAYS, 37 | ) 38 | private var countUnusedPatches: Boolean = false 39 | 40 | override fun run() { 41 | val patches = PatchBundleLoader.Jar(*patchBundles) 42 | 43 | fun VersionMap.buildVersionsString(): String { 44 | if (isEmpty()) return "Any" 45 | 46 | fun buildPatchesCountString(count: Int) = if (count == 1) "1 patch" else "$count patches" 47 | 48 | return entries.joinToString("\n") { (version, count) -> 49 | "$version (${buildPatchesCountString(count)})" 50 | } 51 | } 52 | 53 | fun buildString(entry: Map.Entry) = 54 | buildString { 55 | val (name, versions) = entry 56 | appendLine("Package name: $name") 57 | appendLine("Most common compatible versions:") 58 | appendLine(versions.buildVersionsString().prependIndent("\t")) 59 | } 60 | 61 | PatchUtils.getMostCommonCompatibleVersions( 62 | patches, 63 | packageNames, 64 | countUnusedPatches, 65 | ).entries.joinToString("\n", transform = ::buildString).let(logger::info) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/ListPatchesCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command 2 | 3 | import app.revanced.patcher.PatchBundleLoader 4 | import app.revanced.patcher.patch.Patch 5 | import app.revanced.patcher.patch.options.PatchOption 6 | import picocli.CommandLine.* 7 | import picocli.CommandLine.Help.Visibility.ALWAYS 8 | import java.io.File 9 | import java.util.logging.Logger 10 | 11 | @Command( 12 | name = "list-patches", 13 | description = ["List patches from supplied patch bundles."], 14 | ) 15 | internal object ListPatchesCommand : Runnable { 16 | private val logger = Logger.getLogger(ListPatchesCommand::class.java.name) 17 | 18 | @Parameters( 19 | description = ["Paths to patch bundles."], 20 | arity = "1..*", 21 | ) 22 | private lateinit var patchBundles: Array 23 | 24 | @Option( 25 | names = ["-d", "--with-descriptions"], 26 | description = ["List their descriptions."], 27 | showDefaultValue = ALWAYS, 28 | ) 29 | private var withDescriptions: Boolean = true 30 | 31 | @Option( 32 | names = ["-p", "--with-packages"], 33 | description = ["List the packages the patches are compatible with."], 34 | showDefaultValue = ALWAYS, 35 | ) 36 | private var withPackages: Boolean = false 37 | 38 | @Option( 39 | names = ["-v", "--with-versions"], 40 | description = ["List the versions of the apps the patches are compatible with."], 41 | showDefaultValue = ALWAYS, 42 | ) 43 | private var withVersions: Boolean = false 44 | 45 | @Option( 46 | names = ["-o", "--with-options"], 47 | description = ["List the options of the patches."], 48 | showDefaultValue = ALWAYS, 49 | ) 50 | private var withOptions: Boolean = false 51 | 52 | @Option( 53 | names = ["-u", "--with-universal-patches"], 54 | description = ["List patches which are compatible with any app."], 55 | showDefaultValue = ALWAYS, 56 | ) 57 | private var withUniversalPatches: Boolean = true 58 | 59 | @Option( 60 | names = ["-i", "--index"], 61 | description = ["List the index of each patch in relation to the supplied patch bundles."], 62 | showDefaultValue = ALWAYS, 63 | ) 64 | private var withIndex: Boolean = true 65 | 66 | @Option( 67 | names = ["-f", "--filter-package-name"], 68 | description = ["Filter patches by package name."], 69 | ) 70 | private var packageName: String? = null 71 | 72 | override fun run() { 73 | fun Patch.CompatiblePackage.buildString() = 74 | buildString { 75 | if (withVersions && versions != null) { 76 | appendLine("Package name: $name") 77 | appendLine("Compatible versions:") 78 | append(versions!!.joinToString("\n") { version -> version }.prependIndent("\t")) 79 | } else { 80 | append("Package name: $name") 81 | } 82 | } 83 | 84 | fun PatchOption<*>.buildString() = 85 | buildString { 86 | appendLine("Title: $title") 87 | description?.let { appendLine("Description: $it") } 88 | default?.let { 89 | appendLine("Key: $key") 90 | append("Default: $it") 91 | } ?: append("Key: $key") 92 | 93 | values?.let { values -> 94 | appendLine("\nValid values:") 95 | append(values.map { "${it.value} (${it.key})" }.joinToString("\n").prependIndent("\t")) 96 | } 97 | } 98 | 99 | fun IndexedValue>.buildString() = 100 | let { (index, patch) -> 101 | buildString { 102 | if (withIndex) appendLine("Index: $index") 103 | 104 | append("Name: ${patch.name}") 105 | 106 | if (withDescriptions) append("\nDescription: ${patch.description}") 107 | 108 | if (withOptions && patch.options.isNotEmpty()) { 109 | appendLine("\nOptions:") 110 | append( 111 | patch.options.values.joinToString("\n\n") { option -> 112 | option.buildString() 113 | }.prependIndent("\t"), 114 | ) 115 | } 116 | 117 | if (withPackages && patch.compatiblePackages != null) { 118 | appendLine("\nCompatible packages:") 119 | append( 120 | patch.compatiblePackages!!.joinToString("\n") { 121 | it.buildString() 122 | }.prependIndent("\t"), 123 | ) 124 | } 125 | } 126 | } 127 | 128 | fun Patch<*>.filterCompatiblePackages(name: String) = 129 | compatiblePackages?.any { it.name == name } 130 | ?: withUniversalPatches 131 | 132 | val patches = PatchBundleLoader.Jar(*patchBundles).withIndex().toList() 133 | 134 | val filtered = 135 | packageName?.let { patches.filter { (_, patch) -> patch.filterCompatiblePackages(it) } } ?: patches 136 | 137 | if (filtered.isNotEmpty()) logger.info(filtered.joinToString("\n\n") { it.buildString() }) 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/MainCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command 2 | 3 | import app.revanced.cli.command.utility.UtilityCommand 4 | import app.revanced.library.logging.Logger 5 | import picocli.CommandLine 6 | import picocli.CommandLine.Command 7 | import picocli.CommandLine.IVersionProvider 8 | import java.util.* 9 | 10 | fun main(args: Array) { 11 | Logger.setDefault() 12 | CommandLine(MainCommand).execute(*args).let(System::exit) 13 | } 14 | 15 | private object CLIVersionProvider : IVersionProvider { 16 | override fun getVersion() = 17 | arrayOf( 18 | MainCommand::class.java.getResourceAsStream( 19 | "/app/revanced/cli/version.properties", 20 | )?.use { stream -> 21 | Properties().apply { 22 | load(stream) 23 | }.let { 24 | "ReVanced CLI v${it.getProperty("version")}" 25 | } 26 | } ?: "ReVanced CLI", 27 | ) 28 | } 29 | 30 | @Command( 31 | name = "revanced-cli", 32 | description = ["Command line application to use ReVanced."], 33 | mixinStandardHelpOptions = true, 34 | versionProvider = CLIVersionProvider::class, 35 | subcommands = [ 36 | PatchCommand::class, 37 | OptionsCommand::class, 38 | ListPatchesCommand::class, 39 | ListCompatibleVersions::class, 40 | UtilityCommand::class, 41 | ], 42 | ) 43 | private object MainCommand 44 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/OptionsCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command 2 | 3 | import app.revanced.library.Options 4 | import app.revanced.library.Options.setOptions 5 | import app.revanced.patcher.PatchBundleLoader 6 | import picocli.CommandLine 7 | import picocli.CommandLine.Help.Visibility.ALWAYS 8 | import java.io.File 9 | import java.util.logging.Logger 10 | 11 | @CommandLine.Command( 12 | name = "options", 13 | description = ["Generate options file from patches."], 14 | ) 15 | internal object OptionsCommand : Runnable { 16 | private val logger = Logger.getLogger(OptionsCommand::class.java.name) 17 | 18 | @CommandLine.Parameters( 19 | description = ["Paths to patch bundles."], 20 | arity = "1..*", 21 | ) 22 | private lateinit var patchBundles: Array 23 | 24 | @CommandLine.Option( 25 | names = ["-p", "--path"], 26 | description = ["Path to patch options JSON file."], 27 | showDefaultValue = ALWAYS, 28 | ) 29 | private var filePath: File = File("options.json") 30 | 31 | @CommandLine.Option( 32 | names = ["-o", "--overwrite"], 33 | description = ["Overwrite existing options file."], 34 | showDefaultValue = ALWAYS, 35 | ) 36 | private var overwrite: Boolean = false 37 | 38 | @CommandLine.Option( 39 | names = ["-u", "--update"], 40 | description = ["Update existing options by adding missing and removing non-existent options."], 41 | showDefaultValue = ALWAYS, 42 | ) 43 | private var update: Boolean = false 44 | 45 | override fun run() = 46 | try { 47 | PatchBundleLoader.Jar(*patchBundles).let { patches -> 48 | val exists = filePath.exists() 49 | if (!exists || overwrite) { 50 | if (exists && update) patches.setOptions(filePath) 51 | 52 | Options.serialize(patches, prettyPrint = true).let(filePath::writeText) 53 | } else { 54 | throw OptionsFileAlreadyExistsException() 55 | } 56 | } 57 | } catch (ex: OptionsFileAlreadyExistsException) { 58 | logger.severe("Options file already exists, use --overwrite to override it") 59 | } 60 | 61 | class OptionsFileAlreadyExistsException : Exception() 62 | } 63 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/PatchCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command 2 | 3 | import app.revanced.library.ApkUtils 4 | import app.revanced.library.ApkUtils.applyTo 5 | import app.revanced.library.Options 6 | import app.revanced.library.Options.setOptions 7 | import app.revanced.library.adb.AdbManager 8 | import app.revanced.patcher.PatchBundleLoader 9 | import app.revanced.patcher.PatchSet 10 | import app.revanced.patcher.Patcher 11 | import app.revanced.patcher.PatcherConfig 12 | import kotlinx.coroutines.runBlocking 13 | import picocli.CommandLine 14 | import picocli.CommandLine.Help.Visibility.ALWAYS 15 | import picocli.CommandLine.Model.CommandSpec 16 | import picocli.CommandLine.Spec 17 | import java.io.File 18 | import java.io.PrintWriter 19 | import java.io.StringWriter 20 | import java.util.logging.Logger 21 | 22 | @CommandLine.Command( 23 | name = "patch", 24 | description = ["Patch an APK file."], 25 | ) 26 | internal object PatchCommand : Runnable { 27 | private val logger = Logger.getLogger(PatchCommand::class.java.name) 28 | 29 | @Spec 30 | lateinit var spec: CommandSpec // injected by picocli 31 | 32 | private lateinit var apk: File 33 | 34 | private var integrations = setOf() 35 | 36 | private var patchBundles = emptySet() 37 | 38 | @CommandLine.Option( 39 | names = ["-i", "--include"], 40 | description = ["List of patches to include."], 41 | ) 42 | private var includedPatches = hashSetOf() 43 | 44 | @CommandLine.Option( 45 | names = ["--ii"], 46 | description = ["List of patches to include by their index in relation to the supplied patch bundles."], 47 | ) 48 | private var includedPatchesByIndex = arrayOf() 49 | 50 | @CommandLine.Option( 51 | names = ["-e", "--exclude"], 52 | description = ["List of patches to exclude."], 53 | ) 54 | private var excludedPatches = hashSetOf() 55 | 56 | @CommandLine.Option( 57 | names = ["--ei"], 58 | description = ["List of patches to exclude by their index in relation to the supplied patch bundles."], 59 | ) 60 | private var excludedPatchesByIndex = arrayOf() 61 | 62 | @CommandLine.Option( 63 | names = ["--options"], 64 | description = ["Path to patch options JSON file."], 65 | ) 66 | private var optionsFile: File? = null 67 | 68 | @CommandLine.Option( 69 | names = ["--exclusive"], 70 | description = ["Only include patches that are explicitly specified to be included."], 71 | showDefaultValue = ALWAYS, 72 | ) 73 | private var exclusive = false 74 | 75 | @CommandLine.Option( 76 | names = ["-f", "--force"], 77 | description = ["Bypass compatibility checks for the supplied APK's version."], 78 | showDefaultValue = ALWAYS, 79 | ) 80 | private var force: Boolean = false 81 | 82 | private var outputFilePath: File? = null 83 | 84 | @CommandLine.Option( 85 | names = ["-o", "--out"], 86 | description = ["Path to save the patched APK file to. Defaults to the same directory as the supplied APK file."], 87 | ) 88 | @Suppress("unused") 89 | private fun setOutputFilePath(outputFilePath: File?) { 90 | this.outputFilePath = outputFilePath?.absoluteFile 91 | } 92 | 93 | @CommandLine.Option( 94 | names = ["-d", "--device-serial"], 95 | description = ["ADB device serial to install to. If not supplied, the first connected device will be used."], 96 | // Empty string to indicate that the first connected device should be used. 97 | fallbackValue = "", 98 | arity = "0..1", 99 | ) 100 | private var deviceSerial: String? = null 101 | 102 | @CommandLine.Option( 103 | names = ["--mount"], 104 | description = ["Install by mounting the patched APK file."], 105 | showDefaultValue = ALWAYS, 106 | ) 107 | private var mount: Boolean = false 108 | 109 | @CommandLine.Option( 110 | names = ["--keystore"], 111 | description = [ 112 | "Path to the keystore to sign the patched APK file with. " + 113 | "Defaults to the same directory as the supplied APK file.", 114 | ], 115 | ) 116 | private var keystoreFilePath: File? = null 117 | 118 | @CommandLine.Option( 119 | names = ["--keystore-password"], 120 | description = ["The password of the keystore to sign the patched APK file with. Empty password by default."], 121 | ) 122 | private var keyStorePassword: String? = null // Empty password by default 123 | 124 | @CommandLine.Option( 125 | names = ["--alias"], 126 | description = ["The alias of the keystore entry to sign the patched APK file with."], 127 | showDefaultValue = ALWAYS, 128 | ) 129 | private fun setKeyStoreEntryAlias(alias: String = "ReVanced Key") { 130 | logger.warning("The --alias option is deprecated. Use --keystore-entry-alias instead.") 131 | keyStoreEntryAlias = alias 132 | } 133 | 134 | @CommandLine.Option( 135 | names = ["--keystore-entry-alias"], 136 | description = ["The alias of the keystore entry to sign the patched APK file with."], 137 | showDefaultValue = ALWAYS, 138 | ) 139 | private var keyStoreEntryAlias = "ReVanced Key" 140 | 141 | @CommandLine.Option( 142 | names = ["--keystore-entry-password"], 143 | description = ["The password of the entry from the keystore for the key to sign the patched APK file with."], 144 | ) 145 | private var keyStoreEntryPassword = "" // Empty password by default 146 | 147 | @CommandLine.Option( 148 | names = ["--signer"], 149 | description = ["The name of the signer to sign the patched APK file with."], 150 | showDefaultValue = ALWAYS, 151 | ) 152 | private var signer = "ReVanced" 153 | 154 | @CommandLine.Option( 155 | names = ["-t", "--temporary-files-path"], 156 | description = ["Path to temporary files directory."], 157 | ) 158 | private var temporaryFilesPath: File? = null 159 | 160 | private var aaptBinaryPath: File? = null 161 | 162 | @CommandLine.Option( 163 | names = ["--unsigned"], description = ["Disable signing of the final apk"] 164 | ) 165 | private var unsigned: Boolean = false 166 | 167 | @CommandLine.Option( 168 | names = ["--rip-lib"], description = ["Rip native libs from APK (x86_64 etc.)"] 169 | ) 170 | private var ripLibs = arrayOf() 171 | 172 | @CommandLine.Option( 173 | names = ["-p", "--purge"], 174 | description = ["Purge the temporary resource cache directory after patching."], 175 | showDefaultValue = ALWAYS, 176 | ) 177 | private var purge: Boolean = false 178 | 179 | @CommandLine.Option( 180 | names = ["-w", "--warn"], 181 | description = ["Warn if a patch can not be found in the supplied patch bundles."], 182 | showDefaultValue = ALWAYS, 183 | ) 184 | private var warn: Boolean = false 185 | 186 | @CommandLine.Parameters( 187 | description = ["APK file to be patched."], 188 | arity = "1..1", 189 | ) 190 | @Suppress("unused") 191 | private fun setApk(apk: File) { 192 | if (!apk.exists()) { 193 | throw CommandLine.ParameterException( 194 | spec.commandLine(), 195 | "APK file ${apk.path} does not exist", 196 | ) 197 | } 198 | this.apk = apk 199 | } 200 | 201 | @CommandLine.Option( 202 | names = ["-m", "--merge"], 203 | description = ["One or more DEX files or containers to merge into the APK."], 204 | ) 205 | @Suppress("unused") 206 | private fun setIntegrations(integrations: Array) { 207 | integrations.firstOrNull { !it.exists() }?.let { 208 | throw CommandLine.ParameterException(spec.commandLine(), "Integrations file ${it.path} does not exist.") 209 | } 210 | this.integrations += integrations 211 | } 212 | 213 | @CommandLine.Option( 214 | names = ["-b", "--patch-bundle"], 215 | description = ["One or more bundles of patches."], 216 | required = true, 217 | ) 218 | @Suppress("unused") 219 | private fun setPatchBundles(patchBundles: Set) { 220 | patchBundles.firstOrNull { !it.exists() }?.let { 221 | throw CommandLine.ParameterException(spec.commandLine(), "Patch bundle ${it.name} does not exist") 222 | } 223 | this.patchBundles = patchBundles 224 | } 225 | 226 | @CommandLine.Option( 227 | names = ["--custom-aapt2-binary"], 228 | description = ["Path to a custom AAPT binary to compile resources with."], 229 | ) 230 | @Suppress("unused") 231 | private fun setAaptBinaryPath(aaptBinaryPath: File) { 232 | if (!aaptBinaryPath.exists()) { 233 | throw CommandLine.ParameterException( 234 | spec.commandLine(), 235 | "AAPT binary ${aaptBinaryPath.name} does not exist", 236 | ) 237 | } 238 | this.aaptBinaryPath = aaptBinaryPath 239 | } 240 | 241 | override fun run() { 242 | // region Setup 243 | 244 | val outputFilePath = 245 | outputFilePath ?: File("").absoluteFile.resolve( 246 | "${apk.nameWithoutExtension}-patched.${apk.extension}", 247 | ) 248 | 249 | val temporaryFilesPath = 250 | temporaryFilesPath ?: outputFilePath.parentFile.resolve( 251 | "${outputFilePath.nameWithoutExtension}-temporary-files", 252 | ) 253 | 254 | val optionsFile = 255 | optionsFile ?: outputFilePath.parentFile.resolve( 256 | "${outputFilePath.nameWithoutExtension}-options.json", 257 | ) 258 | 259 | val keystoreFilePath = 260 | keystoreFilePath ?: outputFilePath.parentFile 261 | .resolve("${outputFilePath.nameWithoutExtension}.keystore") 262 | 263 | // endregion 264 | 265 | // region Load patches 266 | 267 | logger.info("Loading patches") 268 | 269 | val patches = PatchBundleLoader.Jar(*patchBundles.toTypedArray()) 270 | 271 | // Warn if a patch can not be found in the supplied patch bundles. 272 | if (warn) { 273 | patches.map { it.name }.toHashSet().let { availableNames -> 274 | (includedPatches + excludedPatches).filter { name -> 275 | !availableNames.contains(name) 276 | } 277 | }.let { unknownPatches -> 278 | if (unknownPatches.isEmpty()) return@let 279 | logger.warning("Unknown input of patches:\n${unknownPatches.joinToString("\n")}") 280 | } 281 | } 282 | 283 | // endregion 284 | val patcherTemporaryFilesPath = temporaryFilesPath.resolve("patcher") 285 | val (packageName, patcherResult) = Patcher( 286 | PatcherConfig( 287 | apk, 288 | patcherTemporaryFilesPath, 289 | aaptBinaryPath?.path, 290 | patcherTemporaryFilesPath.absolutePath, 291 | true, 292 | ), 293 | ).use { patcher -> 294 | val filteredPatches = 295 | patcher.filterPatchSelection(patches).also { patches -> 296 | logger.info("Setting patch options") 297 | 298 | if (optionsFile.exists()) { 299 | patches.setOptions(optionsFile) 300 | } else { 301 | Options.serialize(patches, prettyPrint = true).let(optionsFile::writeText) 302 | } 303 | } 304 | 305 | // region Patch 306 | 307 | patcher.context.packageMetadata.packageName to patcher.apply { 308 | acceptIntegrations(integrations) 309 | acceptPatches(filteredPatches) 310 | 311 | // Execute patches. 312 | runBlocking { 313 | apply(false).collect { patchResult -> 314 | patchResult.exception?.let { 315 | StringWriter().use { writer -> 316 | it.printStackTrace(PrintWriter(writer)) 317 | logger.severe("${patchResult.patch.name} failed:\n$writer") 318 | } 319 | } ?: logger.info("${patchResult.patch.name} succeeded") 320 | } 321 | } 322 | }.get() 323 | // endregion 324 | } 325 | 326 | // region Save 327 | apk.copyTo(temporaryFilesPath.resolve(apk.name), overwrite = true).apply { 328 | patcherResult.applyTo(this, ripLibs) 329 | }.let { patchedApkFile -> 330 | if (!mount && !unsigned) { 331 | ApkUtils.signApk( 332 | patchedApkFile, 333 | outputFilePath, 334 | signer, 335 | ApkUtils.KeyStoreDetails( 336 | keystoreFilePath, 337 | keyStorePassword, 338 | keyStoreEntryAlias, 339 | keyStoreEntryPassword, 340 | ), 341 | ) 342 | } else { 343 | patchedApkFile.copyTo(outputFilePath, overwrite = true) 344 | } 345 | } 346 | 347 | logger.info("Saved to $outputFilePath") 348 | 349 | // endregion 350 | 351 | // region Install 352 | 353 | deviceSerial?.let { serial -> 354 | AdbManager.getAdbManager(deviceSerial = serial.ifEmpty { null }, mount) 355 | }?.install(AdbManager.Apk(outputFilePath, packageName)) 356 | 357 | // endregion 358 | 359 | if (purge) { 360 | logger.info("Purging temporary files") 361 | purge(temporaryFilesPath) 362 | } 363 | } 364 | 365 | /** 366 | * Filter the patches to be added to the patcher. The filter is based on the following: 367 | * 368 | * @param patches The patches to filter. 369 | * @return The filtered patches. 370 | */ 371 | private fun Patcher.filterPatchSelection(patches: PatchSet): PatchSet = 372 | buildSet { 373 | val packageName = context.packageMetadata.packageName 374 | val packageVersion = context.packageMetadata.packageVersion 375 | 376 | patches.withIndex().forEach patch@{ (i, patch) -> 377 | val patchName = patch.name!! 378 | 379 | val explicitlyExcluded = excludedPatches.contains(patchName) || excludedPatchesByIndex.contains(i) 380 | if (explicitlyExcluded) return@patch logger.info("Excluding $patchName") 381 | 382 | // Make sure the patch is compatible with the supplied APK files package name and version. 383 | patch.compatiblePackages?.let { packages -> 384 | packages.singleOrNull { it.name == packageName }?.let { `package` -> 385 | val matchesVersion = 386 | force || `package`.versions?.let { 387 | it.any { version -> version == packageVersion } 388 | } ?: true 389 | 390 | if (!matchesVersion) { 391 | return@patch logger.warning( 392 | "$patchName is incompatible with version $packageVersion. " + 393 | "This patch is only compatible with version " + 394 | packages.joinToString(";") { pkg -> 395 | pkg.versions!!.joinToString(", ") 396 | }, 397 | ) 398 | } 399 | } ?: return@patch logger.fine( 400 | "$patchName is incompatible with $packageName. " + 401 | "This patch is only compatible with " + 402 | packages.joinToString(", ") { `package` -> `package`.name }, 403 | ) 404 | 405 | return@let 406 | } ?: logger.fine("$patchName has no constraint on packages.") 407 | 408 | // If the patch is implicitly used, it will be only included if [exclusive] is false. 409 | val implicitlyIncluded = !exclusive && patch.use 410 | // If the patch is explicitly used, it will be included even if [exclusive] is false. 411 | val explicitlyIncluded = includedPatches.contains(patchName) || includedPatchesByIndex.contains(i) 412 | 413 | val included = implicitlyIncluded || explicitlyIncluded 414 | if (!included) return@patch logger.info("$patchName excluded") // Case 1. 415 | 416 | logger.fine("Adding $patchName") 417 | 418 | add(patch) 419 | } 420 | } 421 | 422 | private fun purge(resourceCachePath: File) { 423 | val result = 424 | if (resourceCachePath.deleteRecursively()) { 425 | "Purged resource cache directory" 426 | } else { 427 | "Failed to purge resource cache directory" 428 | } 429 | logger.info(result) 430 | } 431 | } 432 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/utility/InstallCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command.utility 2 | 3 | import app.revanced.library.adb.AdbManager 4 | import picocli.CommandLine.* 5 | import java.io.File 6 | import java.util.logging.Logger 7 | 8 | @Command( 9 | name = "install", 10 | description = ["Install an APK file to devices with the supplied ADB device serials"], 11 | ) 12 | internal object InstallCommand : Runnable { 13 | private val logger = Logger.getLogger(InstallCommand::class.java.name) 14 | 15 | @Parameters( 16 | description = ["ADB device serials. If not supplied, the first connected device will be used."], 17 | arity = "0..*", 18 | ) 19 | private var deviceSerials: Array? = null 20 | 21 | @Option( 22 | names = ["-a", "--apk"], 23 | description = ["APK file to be installed"], 24 | required = true, 25 | ) 26 | private lateinit var apk: File 27 | 28 | @Option( 29 | names = ["-m", "--mount"], 30 | description = ["Mount the supplied APK file over the app with the supplied package name"], 31 | ) 32 | private var packageName: String? = null 33 | 34 | override fun run() { 35 | fun install(deviceSerial: String? = null) = 36 | try { 37 | AdbManager.getAdbManager(deviceSerial, packageName != null).install(AdbManager.Apk(apk, packageName)) 38 | } catch (e: AdbManager.DeviceNotFoundException) { 39 | logger.severe(e.toString()) 40 | } 41 | 42 | deviceSerials?.forEach(::install) ?: install() 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/utility/UninstallCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command.utility 2 | 3 | import app.revanced.library.adb.AdbManager 4 | import picocli.CommandLine.* 5 | import picocli.CommandLine.Help.Visibility.ALWAYS 6 | import java.util.logging.Logger 7 | 8 | @Command( 9 | name = "uninstall", 10 | description = ["Uninstall a patched app from the devices with the supplied ADB device serials"], 11 | ) 12 | internal object UninstallCommand : Runnable { 13 | private val logger = Logger.getLogger(UninstallCommand::class.java.name) 14 | 15 | @Parameters( 16 | description = ["ADB device serials. If not supplied, the first connected device will be used."], 17 | arity = "0..*", 18 | ) 19 | private var deviceSerials: Array? = null 20 | 21 | @Option( 22 | names = ["-p", "--package-name"], 23 | description = ["Package name of the app to uninstall"], 24 | required = true, 25 | ) 26 | private lateinit var packageName: String 27 | 28 | @Option( 29 | names = ["-u", "--unmount"], 30 | description = ["Uninstall by unmounting the patched APK file"], 31 | showDefaultValue = ALWAYS, 32 | ) 33 | private var unmount: Boolean = false 34 | 35 | override fun run() { 36 | fun uninstall(deviceSerial: String? = null) = 37 | try { 38 | AdbManager.getAdbManager(deviceSerial, unmount).uninstall(packageName) 39 | } catch (e: AdbManager.DeviceNotFoundException) { 40 | logger.severe(e.toString()) 41 | } 42 | 43 | deviceSerials?.forEach { uninstall(it) } ?: uninstall() 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command.utility 2 | 3 | import picocli.CommandLine 4 | 5 | @CommandLine.Command( 6 | name = "utility", 7 | description = ["Commands for utility purposes."], 8 | subcommands = [InstallCommand::class, UninstallCommand::class], 9 | ) 10 | internal object UtilityCommand 11 | -------------------------------------------------------------------------------- /src/main/resources/app/revanced/cli/version.properties: -------------------------------------------------------------------------------- 1 | version=${projectVersion} --------------------------------------------------------------------------------