PHPackages xvq/php-adb - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. xvq/php-adb ActiveLibrary[Utility & Helpers](/categories/utility) xvq/php-adb =========== PHP library to interact with Android devices via ADB. v1.0.5(8mo ago)54282[1 PRs](https://github.com/xvq/php-adb/pulls)MITPHPPHP >=8.1 Since Oct 19Pushed 8mo agoCompare [ Source](https://github.com/xvq/php-adb)[ Packagist](https://packagist.org/packages/xvq/php-adb)[ Docs](https://github.com/xvq/php-adb)[ RSS](/packages/xvq-php-adb/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (7)Used By (0) PHP ADB Library =============== [](#php-adb-library) A PHP library for interacting with Android devices via ADB. Requires ======== [](#requires) - PHP 8.1 or higher - ext-mbstring Installation ============ [](#installation) ``` composer require xvq/php-adb ``` Usage ===== [](#usage) Connect ADB Server ------------------ [](#connect-adb-server) ``` use Xvq\PhpAdb\AdbClient; $adb = new AdbClient('127.0.0.1',5037); ``` List all the devices and get device object ------------------------------------------ [](#list-all-the-devices-and-get-device-object) ``` $devices = $adb->getAllDevices(); $device = $devices[0]; $serials = $adb->getAllDeviceSerials(); //serial $device = $adb->device($serials[0]); $device = $adb->device('8e257561'); //transportId $device = $adb->device(transportId: 2); //when there is only one device, no arguments need to be provided. $device = $adb->device(); ``` Connect or disconnect remote device ----------------------------------- [](#connect-or-disconnect-remote-device) ``` $output = $adb->connect("192.168.1.10:5555"); // output: connected to 192.168.1.10:5555 $output = $adb->disconnect("192.168.1.10:5555"); // output: disconnected from 192.168.1.10:5555 ``` adb forward and adb reverse --------------------------- [](#adb-forward-and-adb-reverse) ``` $device->forward('tcp:6666', 'tcp:5555'); $result = $device->forwardList(); var_dump($result); /* * array( * [ * "serial" => "9e224311", * "local" => "tcp:6666", * "remote" => "tcp:5555" * ] * ) */ $device->reverse('tcp:5555', 'tcp:6666'); $device->reverseList(); ``` Create socket connection to the device -------------------------------------- [](#create-socket-connection-to-the-device) ``` use Xvq\PhpAdb\Enum\Network; // Example: create a video stream connection for scrcpy $con = $device->createConnection(Network::LOCAL_ABSTRACT, 'scrcpy'); foreach ($con->readStream() as $chunk){ //... } $con = $device->createConnection(Network::TCP, 8000); $con->read(500); ``` Run shell command ----------------- [](#run-shell-command) ``` # Argument support array, string $output = $device->shell->run(["getprop", "ro.serial"]); // or $output = $device->shell->run("getprop ro.serial"); // set timeout $output = $device->shell->run("getprop ro.serial", timeout: 5); // stream output foreach ($device->shell->run("cat /sdcard/test.txt", stream: true) as $chunk){ // ... } //use shell v2 protocol $r = $device->shell->runV2("getprop ro.serial"); $command = $r->command; $returnCode = $r->returnCode; $output = $r->output; $stdout = $r->stdout; $stderr = $r->stderr; $device->shell->getProp('ro.serial'); $device->shell->switchAirplane(true); $device->shell->switchWifi(true); $device->shell->getWindowSize(); // ... ``` Take screenshot --------------- [](#take-screenshot) ``` $device->screenshot->save('screenshot.png'); $raw = $device->screenshot->raw(); file_put_contents('screenshot.png', $raw); ``` File Operations --------------- [](#file-operations) ``` // push file $device->file->push('test.txt', '/sdcard/test.txt'); // pull file $device->file->pull('/sdcard/test.txt', 'test.txt'); // read file foreach ($device->file->read('/sdcard/test.txt') as $chunk){ // ... }; // list directory foreach ($device->file->listDirectory('/sdcard/') as $file){ echo $file['name']; echo $file['size']; echo $file['mode']; echo $file['mtime']; } // stat $stat = $device->file->stat('/sdcard/test.txt'); echo $stat['name']; echo $stat['size']; echo $stat['mode']; echo $stat['mtime']; $device->file->copy('/sdcard/test.txt', '/sdcard/test2.txt'); $device->file->move('/sdcard/test2.txt', '/sdcard/test.txt'); $device->file->remove('/sdcard/test.txt'); $device->file->mkdir('/sdcard/test'); ``` APP Operations -------------- [](#app-operations) ``` // Push and install an APK from the local filesystem to the device. // The file './test.apk' will be uploaded to the device and then installed. $result = $device->app->pushAndInstall('./test.apk'); // Install an APK that already exists on the device's storage. $result = $device->app->install('/sdcard/test2.apk'); // $result 1 = success, 2 = need manual confirmation $device->app->start('com.example.test'); // Get the current activity that is in focus. $result = $device->app->currentFocus(); echo $result['package']; echo $result['activity']; echo $result['pid']; $device->app->stop('com.example.test'); $device->app->clear('com.example.test'); $device->app->uninstall('com.example.test'); foreach ($device->app->list() as $packageName){ echo $packageName; } $info = $device->app->info('com.example.test'); // $info is an associative array containing details such as: [ 'package_name' => 'com.example.test', 'version_name' => '1.0.0', 'version_code' => 100, 'flags' => 'SYSTEM', 'first_install_time' => '2024-05-01 10:30:00', 'last_update_time' => '2024-05-10 15:42:00', 'signature' => 'AB:CD:EF:...', 'path' => '/data/app/com.example.test/base.apk', 'sub_apk_paths' => [], ] ``` Input ----- [](#input) ``` use Xvq\PhpAdb\Enum\KeyCode; // Simulate pressing the Home button $device->input->keyEvent(KeyCode::KEY_HOME); // Simulate typing text $device->input->sendText('Hello World'); // Simulate tapping at (100px, 100px) $device->input->tap(100, 100); // Simulate tapping the screen center (50%, 50%) — decimals represent screen percentage $device->input->tap(0.5, 0.5); // Simulate swipe from (100px,100px) → (200px,200px) in 0.5 seconds $device->input->swipe(100, 100, 200, 200, 0.5); // Simulate swipe from (10%,50%) → (90%,50%) in 0.5 seconds — decimals represent screen percentage $device->input->swipe(0.1, 0.5, 0.9, 0.5, 0.5); // Simulate drag from (100px,100px) → (200px,200px) in 0.5 seconds $device->input->drag(100, 100, 200, 200, 0.5); // Simulate mouse wheel scroll down by one unit $device->input->roll(0, 1); // Simulate mouse wheel scroll up by one unit $device->input->roll(0, -1); ``` Other ----- [](#other) ``` $device->reboot(); // get device state ,[device,offline,bootloader] $device->getState(); $v = $device->androidVersion(); // get device info $info = $device->info; echo $info->serial; echo $info->transportId; echo $info->product; echo $info->model; echo $info->device; //adb root $device->root(); // get device features $device->getFeatures(); // open browser $device->shell->openBrowser("https://www.baidu.com"); // is screen on $device->shell->isScreenOn(); // get window size $arr = $device->shell->getWindowSize(); echo $arr['width']; echo $arr['height']; // There are many other available methods as well // please refer to the source code for details. ``` Thanks ====== [](#thanks) This project is developed with reference to [openatx/adbutils](https://github.com/openatx/adbutils). License ======= [](#license) [MIT](LICENSE) ### Health Score 36 — LowBetter than 79% of packages Maintenance60 Regular maintenance activity Popularity19 Limited adoption so far Community7 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 6 Last Release 254d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/9435565?v=4)[JoeyRoe](/maintainers/haozy)[@haozy](https://github.com/haozy) --- Top Contributors [![xvq](https://avatars.githubusercontent.com/u/20119238?v=4)](https://github.com/xvq "xvq (1 commits)") ### Embed Badge ![Health badge](/badges/xvq-php-adb/health.svg) ``` [![Health](https://phpackages.com/badges/xvq-php-adb/health.svg)](https://phpackages.com/packages/xvq-php-adb) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)