0.2.3 • Published 2d agoCLI

serve-android

Licence

MIT

Version

0.2.3

Deps

Size

121 kB

Vulns

Weekly

Summary Dependency Versions

Serve Android

Android device control and streaming via web interface. Stream your Android device screen to a web browser and control it remotely with your mouse and keyboard.

Features

Device Discovery - Automatically detects all connected Android devices
Remote Control - Control your device via web interface
- Tap/click to touch
- Drag to swipe
- Type text
- Key commands (Back, Home, Volume, etc.)
Live Streaming - Real-time device screen streaming
AI Integration - REST API for AI agents to control devices
High Performance - Optimized for 60+ FPS streaming

Requirements

Node.js/Bun - JavaScript runtime
Android Debug Bridge (ADB) - For device communication
- macOS: brew install android-platform-tools
- Linux: apt-get install adb
- Windows: Download from Android Developer Tools

Quick Start

For End Users (Web UI)

Connect your Android device
- USB: Connect via USB cable and enable USB debugging
- Emulator: Start an Android emulator
- Verify: adb devices

Start Serve Android

npx serve-android
# or with bun
bunx serve-android

Open your browser
- Navigate to http://localhost:3000
- Select a device from the dropdown
- Start controlling!

For Developers (Using the Skill SDK)

Install the skill in your project
```
npm install @serve-android/skill
```
Start the Serve Android server
```
npx serve-android
```

Use the SDK in your code

import { ServeDeviceClient } from '@serve-android/skill'

const client = new ServeDeviceClient('http://localhost:3000')
const devices = await client.getDevices()
await client.tap(devices[0].id, 540, 960)

Read the Skill Installation Guide for more examples and use cases.

Project Structure

serve-android/
├── server/          # Bun backend (TypeScript)
│   └── src/
│       ├── adb/     # Android Debug Bridge integration
│       ├── api/     # REST API routes
│       └── main.ts  # Server entry point
├── client/          # React frontend (TypeScript)
│   └── src/
│       ├── components/  # React components
│       ├── hooks/       # Custom hooks
│       └── App.tsx      # Main app
└── shared/          # Shared types and utilities

API Endpoints

Devices

GET /api/devices - List all connected devices
GET /api/devices/{deviceId} - Get device info
GET /api/devices/{deviceId}/screenshot - Get current screenshot

Input Control

POST /api/devices/{deviceId}/input/tap - Tap at coordinates
POST /api/devices/{deviceId}/input/swipe - Swipe gesture
POST /api/devices/{deviceId}/input/type - Type text
POST /api/devices/{deviceId}/input/key - Press key

Streaming

WS /api/devices/{deviceId}/stream - WebSocket for video frames

Example Usage

Web UI

Connect device via USB
Open http://localhost:5173
Click on your device to start streaming
Click/drag/type to control

API (for AI agents)

# Get devices
curl http://localhost:3000/api/devices

# Take screenshot
curl http://localhost:3000/api/devices/device_id/screenshot | base64 -D > screen.png

# Tap at coordinates
curl -X POST http://localhost:3000/api/devices/device_id/input/tap \
  -H "Content-Type: application/json" \
  -d '{"x": 540, "y": 960}'

# Swipe
curl -X POST http://localhost:3000/api/devices/device_id/input/swipe \
  -H "Content-Type: application/json" \
  -d '{"x1": 540, "y1": 1000, "x2": 540, "y2": 500, "duration": 300}'