From 19200eacc1e4cbf245aa10cb22f2a6677cff6b36 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Sun, 8 Jan 2023 14:37:10 +0100 Subject: [PATCH 1/7] docs: init --- docs/0_prerequisites.md | 17 ++++++++++ docs/1_usage.md | 74 +++++++++++++++++++++++++++++++++++++++++ docs/README.md | 8 +++++ 3 files changed, 99 insertions(+) create mode 100644 docs/0_prerequisites.md create mode 100644 docs/1_usage.md create mode 100644 docs/README.md diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md new file mode 100644 index 0000000..c802b25 --- /dev/null +++ b/docs/0_prerequisites.md @@ -0,0 +1,17 @@ +# 💼 Prerequisites + +To use the ReVanced CLI, you will need to fulfill certain requirements. + +## 🤝 Requirements + +- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb), the command-line tool that lets + you communicate with a device (optional). +- A x86/x86_64 host (or a custom AAPT binary for your architecture) +- Zulu OpenJDK 17 +- An APK file (e.g. YouTube v17.49.37 or YouTube Music v5.36.51) + +## ⏭️ Whats next + +The next section will show, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli). + +Continue: [🛠️ Using the ReVanced CLI](1_usage.md) diff --git a/docs/1_usage.md b/docs/1_usage.md new file mode 100644 index 0000000..e600e8b --- /dev/null +++ b/docs/1_usage.md @@ -0,0 +1,74 @@ +# 🛠️ Using the ReVanced CLI + +Lean how to use the ReVanced CLI. + +## ⚡ Setup + +1. Make sure your device is connected + + ```bash + adb shell exit + ``` + + If you plan to use the root variant, check if you have root access + + ```bash + adb shell su -c exit + ``` + +2. Copy the ADB device name + + ```bash + adb devices + ``` + +## 🔨 ReVanced CLI Usage + +- ### Show all available options for the ReVanced CLI + + ```bash + java -jar revanced-cli.jar -h + ``` + +- ### List all available patches inside supplied bundles + + ```bash + java -jar revanced-cli.jar \ + -b revanced-patches.jar \ + -l + ``` + +- ### Use the ReVanced CLI without root permissions + + ```bash + java -jar revanced-cli.jar \ + -a input.apk \ + -c \ + -o unpatched-output.apk \ + -b revanced-patches.jar + ``` + +- ### Mount the patched application with root permissions over the installed application + + ```bash + java -jar revanced-cli.jar \ + -a input.apk \ + -c \ + -d device-name \ + -o patched-output.apk \ + -b revanced-patches.jar \ + -e microg-support \ + --mount + ``` + +> **Note**: +> +> - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you have to exclude + the `microg-support` patch from the [ReVanced Patches](https://github.com/revanced/revanced-patches) with the + option `-e microg-support`. +> +> - Some patches from the [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require + the [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. +> +> - If you supplied a device with the option `-d`, the patched application will be automatically installed on the + device. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..a4d2749 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,8 @@ +# 💻 Documentation and guides of ReVanced CLI + +This documentation explain, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli). + +## 📖 Table of contents + +1. [💼 Prerequisites](0_prerequisites.md) +2. [🛠️ Using the ReVanced CLI](1_usage.md) From 6bd7d42e32450974a52e1bb9df4a31512d399842 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Sun, 8 Jan 2023 14:46:13 +0100 Subject: [PATCH 2/7] ci: dispatch event to `revanced/revanced-documentation` on push to `/docs` --- .github/workflows/update-documentation.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/update-documentation.yml diff --git a/.github/workflows/update-documentation.yml b/.github/workflows/update-documentation.yml new file mode 100644 index 0000000..aa0ed1b --- /dev/null +++ b/.github/workflows/update-documentation.yml @@ -0,0 +1,18 @@ +name: Update documentation + +on: + push: + paths: + - docs/** + +jobs: + trigger: + runs-on: ubuntu-latest + name: Dispatch event to documentation repository + steps: + - uses: peter-evans/repository-dispatch@v2 + with: + token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN }} + repository: revanced/revanced-documentation + event-type: update-documentation + client-payload: '{"repo": "${{ github.event.repository.name }}", "ref": "${{ github.ref }}"}' From 50df4e117e082370890be76da246fb2929ff2870 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Mon, 9 Jan 2023 10:11:15 +0100 Subject: [PATCH 3/7] docs: improve wording and accuracy --- docs/1_usage.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/1_usage.md b/docs/1_usage.md index e600e8b..18cbdbd 100644 --- a/docs/1_usage.md +++ b/docs/1_usage.md @@ -2,7 +2,7 @@ Lean how to use the ReVanced CLI. -## ⚡ Setup +## ⚡ Setup (optional) 1. Make sure your device is connected @@ -30,7 +30,7 @@ Lean how to use the ReVanced CLI. java -jar revanced-cli.jar -h ``` -- ### List all available patches inside supplied bundles +- ### List all available patches from supplied patch bundles ```bash java -jar revanced-cli.jar \ @@ -64,11 +64,11 @@ Lean how to use the ReVanced CLI. > **Note**: > > - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you have to exclude - the `microg-support` patch from the [ReVanced Patches](https://github.com/revanced/revanced-patches) with the + the `microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the option `-e microg-support`. > -> - Some patches from the [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require - the [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. +> - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require + [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. > > - If you supplied a device with the option `-d`, the patched application will be automatically installed on the device. From f4e74cb4f2c1f9d1627197660a42847e0256e9c9 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Fri, 13 Jan 2023 00:13:45 +0100 Subject: [PATCH 4/7] docs: improve CLI usage commands --- docs/1_usage.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/1_usage.md b/docs/1_usage.md index 18cbdbd..7e5e240 100644 --- a/docs/1_usage.md +++ b/docs/1_usage.md @@ -51,6 +51,7 @@ Lean how to use the ReVanced CLI. - ### Mount the patched application with root permissions over the installed application ```bash + adb install input.apk # make sure the same version is installed java -jar revanced-cli.jar \ -a input.apk \ -c \ From 1753a1aa3ea9b0fb8614feaa882a76aaf7cb16d6 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Fri, 13 Jan 2023 14:41:18 +0100 Subject: [PATCH 5/7] ci: give jobs names --- .github/workflows/pull_request.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index c1fcea7..605e7a7 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -11,6 +11,7 @@ env: jobs: pull-request: + name: Open pull request runs-on: ubuntu-latest steps: - name: Checkout From aaf452a1030d98b8ff030628e1653d253b6e3c51 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Fri, 13 Jan 2023 14:41:38 +0100 Subject: [PATCH 6/7] refactor: fix formatting --- .github/workflows/release.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8d936d5..69aec3e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,5 @@ name: Release + on: workflow_dispatch: push: @@ -9,6 +10,7 @@ on: branches: - main - dev + jobs: release: name: Release From d15505adaaa41d15b9740c7c60158b6ae70cd226 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Fri, 13 Jan 2023 15:50:39 +0100 Subject: [PATCH 7/7] ci: downgrade semantic release and plugins to v19 --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 69aec3e..2b1df23 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,7 +32,7 @@ jobs: node-version: "latest" cache: 'npm' - name: Setup semantic-release - run: npm install semantic-release @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D + run: npm install semantic-release@19.0.5 @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin@1.7.4 -D - name: Create release env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}