You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Ivan Gorinov d706c5df39 Enable video output file, with pts set by server 6 years ago
app Enable video output file, with pts set by server 6 years ago
assets Update README 6 years ago
config Apply Genymobile rules for Android projects 6 years ago
gradle/wrapper Upgrade gradle 6 years ago
prebuilt-deps Update SDL (2.0.9) for Windows 6 years ago
scripts Rename SCRCPY_SERVER_JAR to SCRCPY_SERVER_PATH 6 years ago
server Enable video output file, with pts set by server 6 years ago
.gitignore Convert server to an Android project 6 years ago
BUILD.md Explain how to install up-to-date meson 6 years ago
DEVELOP.md Add developer documentation 6 years ago
FAQ.md Add link to FLAG_SECURE in FAQ 6 years ago
LICENSE Add Apache 2 LICENSE file 6 years ago
Makefile.CrossWindows Update SDL (2.0.9) for Windows 6 years ago
README.md Replace Ctrl by Meta for volume shortcuts on MacOS 6 years ago
build.gradle Upgrade gradle 6 years ago
cross_win32.txt Fix SDL 2.0.9 for Windows 6 years ago
cross_win64.txt Fix SDL 2.0.9 for Windows 6 years ago
gradle.properties Enable video output file, with pts set by server 6 years ago
gradlew Convert server to an Android project 6 years ago
gradlew.bat Convert server to an Android project 6 years ago
meson.build Explicitly use ISO C11 6 years ago
meson_options.txt Use a meson option to crossbuild for Windows 6 years ago
run Rename SCRCPY_SERVER_JAR to SCRCPY_SERVER_PATH 6 years ago
settings.gradle Convert server to an Android project 6 years ago

README.md

scrcpy (v1.4)

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:

For Gentoo, an Ebuild is available: scrcpy/.

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

The app may be started directly in fullscreen:

scrcpy -f

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) (Cmd+ on MacOS)
click on VOLUME_DOWN Ctrl+ (down) (Cmd+ on MacOS)
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
push file to /sdcard/ drag & drop non-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