Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashishb/adb-enhanced
🔪Swiss-army knife for Android testing and development 🔪 ⛺
https://github.com/ashishb/adb-enhanced
adb android android-development developer-tools
Last synced: 2 days ago
JSON representation
🔪Swiss-army knife for Android testing and development 🔪 ⛺
- Host: GitHub
- URL: https://github.com/ashishb/adb-enhanced
- Owner: ashishb
- License: apache-2.0
- Created: 2017-01-20T07:33:22.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T06:34:12.000Z (4 months ago)
- Last Synced: 2024-10-29T15:35:18.280Z (about 1 month ago)
- Topics: adb, android, android-development, developer-tools
- Language: Python
- Homepage: https://ashishb.net/tech/introducing-adb-enhanced-a-swiss-army-knife-for-android-development/
- Size: 8.04 MB
- Stars: 1,222
- Watchers: 34
- Forks: 79
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-android - ADB Enhanced - a command-line wrapper around ADB for developers, so that, developers don't have to remember esoteric version-dependent commands (Libraries / Debugging Tools)
- awesome-android - ADB Enhanced - a command-line wrapper around ADB for developers, so that, developers don't have to remember esoteric version-dependent commands (Libraries / Debugging Tools)
- awesome-list - ashishb/adb-enhanced - 🔪Swiss-army knife for Android testing and development 🔪 ⛺ (Python)
README
# ADB Enhanced [](https://pepy.tech/project/adb-enhanced) [](https://badge.fury.io/py/adb-enhanced)
ADB-Enhanced is a Swiss army knife for Android testing and development.
A command-line interface to trigger various scenarios like screen rotation, battery saver mode, data saver mode, doze mode, and permission grant/revocation. It's a wrapper around `adb` and not a replacement.
[](https://github.com/ashishb/adb-enhanced/actions/workflows/lint-python.yaml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/lint-markdown.yaml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/lint-yaml.yaml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/install-adbe.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-installtests.yml) [](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/install-adb-enhanced-from-pip.yml) [](https://github.com/ashishb/adb-enhanced/actions/workflows/install-adb-enhanced-from-homebrew.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api16.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api21.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api22.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api23.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api24.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api25.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api26.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api27.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api28.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api29.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api31.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api30.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api31.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api32.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api33.yml)
[](https://github.com/ashishb/adb-enhanced/actions/workflows/adbe-unittests-api34.yml)
[](https://asciinema.org/a/0IhbOF6QNIhBlgtO6VgzNmTbK)
## Release announcement
See [Release announcement](https://ashishb.net/tech/introducing-adb-enhanced-a-swiss-army-knife-for-android-development/)
## Installation
### Recommended
`sudo pip3 install adb-enhanced`
### Alternative on Mac OS via Homebrew [](https://formulae.brew.sh/formula/adb-enhanced)
`brew install adb-enhanced`
## Note
1. `sudo pip install adb-enhanced` works only for Python 3. Python 2 is no longer supported.
1. If you don't have sudo access or you are installing without sudo then `adbe` might not be configured correctly in the path.
1. To set up bash/z-sh auto-completion, execute `sudo pip3 install infi.docopt-completion && docopt-completion $(which adbe)` after installing adb-enhanced.
## Examples
### Device configuration
* Turn doze mode on
`adbe doze on`
* Turn mobile-data off
`adbe mobile-data off`
* Turn on battery saver
`adbe battery saver on`
* Don't keep activities in the background
`adbe dont-keep-activities on`
* Take a screenshot
`adbe screenshot ~/Downloads/screenshot1.png`
* Take a video
`adbe screenrecord video.mp4 # Press ^C when finished`
* Turn Wireless Debug mode on
`adbe enable wireless debugging`
### Permissions
* Grant storage-related runtime permissions
`adbe permissions grant com.example storage`
* Revoke storage-related runtime permissions
`adbe permissions revoke com.example storage`
### Interacting with app
* Start an app
`adbe start com.example`
* Kill an app
`adbe force-stop com.example`
* Clear app data - equivalent of uninstall and reinstall
`adbe clear-data com.example`
* ls/cat/rm any file without worrying about adding "run-as" or "su root"
`adbe ls /data/data/com.example/databases` # Works as long as com.example is a debuggable package or shell has the root permission or directory has been made publicly accessible
### Device info
* Detailed device info including model name, Android API version etc, device serial
```bash
$ adbe devices
Unlock Device "dcc54112" and give USB debugging access to this PC/Laptop by unlocking and reconnecting the device. More info about this device: "unauthorized usb:339869696X transport_id:17"
Serial ID: dcc54111
Manufacturer: OnePlus
Model: ONEPLUS A5000 (OnePlus 5T)
Release: 8.1.0
SDK version: 27
CPU: arm64-v8a
Serial ID: emulator-5554
Manufacturer: unknown
Model: Android SDK built for x86
Release: 4.4.2
SDK version: 19
CPU: x86
```
### App info
* Detailed information about app version, target SDK version, permissions (requested, granted, denied), installer package name, etc.
```bash
$ adbe app info com.google.android.youtube
App name: com.google.android.youtube
Version: 12.17.41
Version Code: 121741370
Is debuggable: False
Min SDK version: 21
Target SDK version: 26
Permissions:
Install time granted permissions:
com.google.android.c2dm.permission.RECEIVE
android.permission.USE_CREDENTIALS
com.google.android.providers.gsf.permission.READ_GSERVICES
com.google.android.youtube.permission.C2D_MESSAGE
android.permission.MANAGE_ACCOUNTS
android.permission.SYSTEM_ALERT_WINDOW
android.permission.NFC
android.permission.CHANGE_NETWORK_STATE
android.permission.RECEIVE_BOOT_COMPLETED
com.google.android.gms.permission.AD_ID_NOTIFICATION
android.permission.INTERNET
android.permission.GET_PACKAGE_SIZE
android.permission.ACCESS_NETWORK_STATE
android.permission.VIBRATE
android.permission.ACCESS_WIFI_STATE
android.permission.WAKE_LOCK
Runtime Permissions not granted and not yet requested:
android.permission.WRITE_EXTERNAL_STORAGE
android.permission.MANAGE_DOCUMENTS
android.permission.GET_ACCOUNTS
android.permission.CAMERA
android.permission.RECORD_AUDIO
android.permission.READ_CONTACTS
android.permission.ACCESS_FINE_LOCATION
android.permission.ACCESS_COARSE_LOCATION
android.permission.READ_PHONE_STATE
android.permission.SEND_SMS
android.permission.RECEIVE_SMS
com.sec.android.provider.badge.permission.READ
com.sec.android.provider.badge.permission.WRITE
com.htc.launcher.permission.READ_SETTINGS
com.htc.launcher.permission.UPDATE_SHORTCUT
com.sonyericsson.home.permission.BROADCAST_BADGE
com.sonymobile.home.permission.PROVIDER_INSERT_BADGE
android.permission.READ_EXTERNAL_STORAGE
Installer package name: None
```
* App backup to a tar file unlike the Android-specific .ab format
```bash
$ adbe app backup com.google.android.youtube backup.tar
you might have to confirm the backup manually on your device's screen, enter "00" as password...
Successfully backed up data of app com.google.android.youtube to backup.tar
```
### Usage
```bash
adbe [options] airplane (on | off)
adbe [options] alarm (all | top | pending | history)
adbe [options] animations (on | off)
adbe [options] app backup []
adbe [options] app info
adbe [options] app path
adbe [options] app signature
adbe [options] apps list (all | system | third-party | debug | backup-enabled)
adbe [options] battery level
adbe [options] battery reset
adbe [options] battery saver (on | off)
adbe [options] cat
adbe [options] clear-data
adbe [options] dark mode (on | off)
adbe [options] devices
adbe [options] (enable | disable) wireless debugging
adbe [options] dont-keep-activities (on | off)
adbe [options] doze (on | off)
adbe [options] dump-ui
adbe [options] force-stop
adbe [options] gfx (on | off | lines)
adbe [options] input-text
adbe [options] install
adbe [options] jank
adbe [options] layout (on | off)
adbe [options] location (on | off)
adbe [options] ls [-a] [-l] [-R|-r]
adbe [options] mobile-data (on | off)
adbe [options] mobile-data saver (on | off)
adbe [options] mv [-f]
adbe [options] notifications list
adbe [options] open-url
adbe [options] overdraw (on | off | deut)
adbe [options] permission-groups list all
adbe [options] permissions (grant | revoke) (calendar | camera | contacts | location | microphone | notifications | phone | sensors | sms | storage)
adbe [options] permissions list (all | dangerous)
adbe [options] press back
adbe [options] pull [-a]
adbe [options] pull [-a]
adbe [options] push
adbe [options] restart
adbe [options] restrict-background (true | false)
adbe [options] rm [-f] [-R|-r]
adbe [options] rotate (landscape | portrait | left | right)
adbe [options] rtl (on | off)
adbe [options] screen (on | off | toggle)
adbe [options] screenrecord
adbe [options] screenshot
adbe [options] show-taps (on | off)
adbe [options] standby-bucket get
adbe [options] standby-bucket set (active | working_set | frequent | rare)
adbe [options] start
adbe [options] stay-awake-while-charging (on | off)
adbe [options] stop
adbe [options] top-activity
adbe [options] uninstall [--first-user]
adbe [options] wifi (on | off)
```
### Options
```bash
-e, --emulator directs the command to the only running emulator
-d, --device directs the command to the only connected "USB" device
-s, --serial SERIAL directs the command to the device or emulator with the given serial number or qualifier.
Overrides ANDROID_SERIAL environment variable.
-l For long list format, only valid for "ls" command
-R For recursive directory listing, only valid for "ls" and "rm" command
-r For delete file, only valid for "ls" and "rm" command
-f For forced deletion of a file, only valid for "rm" command
-v, --verbose Verbose mode
```
## Python3 migration timeline
* Nov 27, 2017 - Code is Python3 compatible
* Jan 18, 2018 - pip (python package manager) has the updated version which is Python3 compatible
* Nov 15, 2018 - Python2 based installation discouraged. Python3 is recommended.
* Dec 31, 2018 - Python2 will not be officially supported after Dec 31, 2018.
* May 7, 2020 - Python2 no longer works with the current master branch
## Testing
```bash
make lint
make test
```
## Release a new build
A new build can be released using [`release/release.py`](https://github.com/ashishb/adb-enhanced/blob/master/release/release.py) script.
Build a test release via `make release_debug`.
Build a production release via `make release_production`
## Updating docs for ReadTheDocs
```bash
make documentation
```
Note that this happens automatically during `make release_production`.
You will have to do `brew install pandoc` if you are missing pandoc.
Note: The inspiration for this project came from [android-scripts](https://github.com/dhelleberg/android-scripts).
[](https://repology.org/project/python:adb-enhanced/versions)
## Contributors
