phonefarm-cloud-connect

Connect your local Android device to the PhoneFarm Cloud platform.

Usage

No install required — run directly with npx:

npx phonefarm-cloud-connect --server ws://yourserver:8890 --code ABCD12

Or install globally:

npm install -g phonefarm-cloud-connect
phonefarm-cloud-connect --server ws://yourserver:8890 --code ABCD12

Setup

1. Go to the PhoneFarm dashboard → Devices → Add Device → Cloud Relay
2. Click Generate Code to get a 6-char code
3. Connect your Android phone via USB and enable USB Debugging
4. Run the command above

The device will appear in your dashboard automatically.

Options

--server   WebSocket URL of your PhoneFarm server  (default: ws://localhost:8890)
--code     6-char connection code from the dashboard  [required]
--serial   ADB device serial (auto-detects if only one connected)
--fps      Stream FPS 1-30  (default: 8)
--quality  JPEG quality 10-95  (default: 35)
--scale    Screen scale 0.1-1.0  (default: 0.4)

Requirements

• Node.js 18+
• Android Platform Tools (adb in PATH)
• USB Debugging enabled on the phone

Optional: Better Image Quality

Install sharp for faster, smaller JPEG frames:

npm install -g sharp phonefarm-cloud-connect