docs: init (#191)

This commit is contained in:
oSumAtrIX 2023-01-08 16:43:19 +01:00 committed by GitHub
commit e6bb05c0b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 117 additions and 0 deletions

View File

@ -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 }}"}'

17
docs/0_prerequisites.md Normal file
View File

@ -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)

74
docs/1_usage.md Normal file
View File

@ -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.

8
docs/README.md Normal file
View File

@ -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)