scrcpy/README.md
Romain Vimont ce6e5d1969 Explain how to install adb on Mac OS
The package scrcpy from Homebrew does not install adb.
2018-08-17 19:51:25 +02:00

5.1 KiB
Raw Blame History

scrcpy (v1.3)

This application provides display and control of Android devices connected on USB (or over TCP/IP). It does not require any root access. It works on GNU/Linux, Windows and MacOS.

screenshot

Requirements

The Android part requires at least API 21 (Android 5.0).

Make sure you enabled adb debugging on your device(s).

Get the app

Linux

On Linux, you typically need to build the app manually. Don't worry, it's not that hard.

For Arch Linux, two AUR packages have been created by users:

Windows

For Windows, for simplicity, prebuilt archives with all the dependencies (including adb) are available:

You can also build the app manually.

Mac OS

The application is available in Homebrew. Just install it:

brew install scrcpy

You need adb, accessible from your PATH. If you don't have it yet:

brew cask install android-platform-tools

You can also build the app manually.

Run

Plug an Android device, and execute:

scrcpy

It accepts command-line arguments, listed by:

scrcpy --help

For example, to decrease video bitrate to 2Mbps (default is 8Mbps):

scrcpy -b 2M

To limit the video dimensions (e.g. if the device is 2540×1440, but the host screen is smaller, or cannot decode such a high definition):

scrcpy -m 1024

The device screen may be cropped to mirror only part of the screen:

scrcpy -c 1224:1440:0:0   # 1224x1440 at offset (0,0)

If several devices are listed in adb devices, you must specify the serial:

scrcpy -s 0123456789abcdef

To show physical touches while scrcpy is running:

scrcpy -t

Shortcuts

Action Shortcut
switch fullscreen mode Ctrl+f
resize window to 1:1 (pixel-perfect) Ctrl+g
resize window to remove black borders Ctrl+x | Double-click¹
click on HOME Ctrl+h | Middle-click
click on BACK Ctrl+b | Right-click²
click on APP_SWITCH Ctrl+s
click on MENU Ctrl+m
click on VOLUME_UP Ctrl+ (up)
click on VOLUME_DOWN Ctrl+ (down)
click on POWER Ctrl+p
turn screen on Right-click²
paste computer clipboard to device Ctrl+v
enable/disable FPS counter (on stdout) Ctrl+i
install APK from computer drag & drop APK file

¹Double-click on black borders to remove them.
²Right-click turns the screen on if it was off, presses BACK otherwise.

Why scrcpy?

A colleague challenged me to find a name as unpronounceable as gnirehtet.

strcpy copies a string; scrcpy copies a screen.

How to build?

See BUILD.

Common issues

See the FAQ.

Developers

Read the developers page.

Licence

Copyright (C) 2018 Genymobile

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Articles