feat: init docs

2026-01-20 17:53:56 +00:00 · 2023-08-07 05:00:41 +03:00
parent 7e5ec5b7a2
commit 6a093ea3a7
49 changed files with 10206 additions and 6098 deletions
--- a/docusaurus/docs/guide/revanced-cli/1_usage.md
+++ b/docusaurus/docs/guide/revanced-cli/1_usage.md
@@ -0,0 +1,76 @@
+# 🛠️ Using ReVanced CLI
+
+Learn how to ReVanced CLI.
+
+## ⚡ Setup ADB
+
+1. Ensure that ADB is working
+
+   ```bash
+   adb shell exit
+   ```
+
+   If you want to deploy the patched APK file on your device by mounting it on top of the original APK file, you will need root access. This is optional.
+
+   ```bash
+   adb shell su -c exit
+   ```
+
+2. Get the name of your device
+
+   ```bash
+   adb devices
+   ```
+
+## 🔨 Using ReVanced CLI
+
+- ### ⚙️ Show all available options for ReVanced CLI
+
+  ```bash
+  java -jar revanced-cli.jar -h
+  ```
+
+- ### 📃 List all available patches from supplied patch bundles
+
+  ```bash
+  java -jar revanced-cli.jar
+   -b revanced-patches.jar \
+   -l # Names of all patches will be in kebab-case
+  ```
+
+- ### 💉 Use ReVanced CLI to patch an APK file but deploy without root permissions
+
+  This will deploy the patched APK file on your device by installing it.
+
+  ```bash
+  java -jar revanced-cli.jar \
+   -a input.apk \
+   -o patched-output.apk \
+   -b revanced-patches.jar \
+   -d device-name
+  ```
+
+- ### 👾 Use ReVanced CLI to patch an APK file but deploy with root permissions
+
+  This will deploy the patched APK file on your device by mounting it on top of the original APK file.
+
+  ```bash
+  adb install input.apk
+  java -jar revanced-cli.jar \
+   -a input.apk \
+   -o patched-output.apk \
+   -b revanced-patches.jar \
+   -e vanced-microg-support \
+   -d device-name \
+   --mount
+  ```
+
+  > **Note**: Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also require [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. ReVanced Patcher will merge ReVanced Integrations automatically, depending on if the supplied patches require them.
+
+- ### ⚙️ Supply options to patches using ReVanced CLI
+
+  Some patches provide options. Currently, ReVanced CLI will generate and consume an `options.json` file at the location that is specified in `-o`. If the option is not specified, the options file will be generated in the current working directory.
+
+  The options file contains all options from supplied patch bundles.
+
+  > **Note**: The `options.json` file will be generated at the first time you use ReVanced CLI to patch an APK file for now. This will be changed in the future.