English | 繁體中文
A desktop service built on scrcpy. It runs in the system tray, finds Android devices on the local network, reconnects paired devices, and opens their screens. Add-ons written in JavaScript extend it.
- Device discovery and connection. Wireless debugging is followed through mDNS and adb. Only paired devices are connected; other devices on the same network are not. When a paired device stops announcing itself (for example while its screen is locked), its last known address is tried. USB devices are supported as well.
- Screens. The screen of a device, or the window of a single app on a display of its own, with a floating toolbar (back, home, rotate, … and the buttons add-ons add). The buttons shown and their order are set in the settings.
- Files. Sending files to a device and opening a file on it, from the program or from the context menu of the file manager (Windows Explorer; Dolphin, Nemo and Nautilus on Linux).
- Tray. Closing the main window hides it to the system tray and the program keeps running (the setting
close_to_trayturns this off). The program can also start at login. - Windows 11 widget. An optional widget shows connected devices and battery levels. Expand a device to open its screen or details. Enable it in Settings, then add it from Win + W → +. Turning it off unregisters only the widget. Registration may request administrator permission and temporarily enable Developer Mode; the previous value is restored afterwards. No signing is performed. Medium and large sizes, light/dark Windows themes and the application's language packs are supported. The app must be running for live device information; battery updates follow the existing device refresh setting. Windows controls the card's visual theme, independently of app CSS themes.
- Appearance. Themes (CSS) and language packs. English and Traditional Chinese are built in.
- Add-ons. A folder with
addon.jsonandmain.js, run in a sandboxed JavaScript engine (QuickJS) with the permissions granted at install. An add-on can add menu entries and toolbar buttons, react to events, declare settings (the program draws the form), run shell commands on a device, start programs on the computer, and receive the live video of a screen (for example for image recognition).
scrcpy, adb and the scrcpy server are not included. On first run the program asks for confirmation before downloading a scrcpy release from the official GitHub releases (the archive contains all three, so their versions always match); the file name, size and SHA-256 are shown first. The default is v5.0.1, the release the program is tested with; the version is a setting.
Packages are attached to the Releases page:
| System | Package |
|---|---|
| Windows | the installer (…_x64-setup.exe; per user, no administrator needed) or the portable zip (a portable.txt next to the program keeps its data there) |
| Linux (x86_64) | the .deb package (needs WebKitGTK 4.1, GTK 3 and the Ayatana app indicator; apt install ./…deb installs them) or the plain executable |
Device requirements: Android 11 or later with Developer options → Wireless debugging on, paired once from the program ("Pair a device"). A device connected by USB with USB debugging on does not need pairing.
- Writing an add-on: docs/ADDONS.md (繁體中文); a working example is in docs/example-addon/.
- TypeScript types: the package
scrcpy-agent-addon-api, built bynpm run addon-typesas a.tgzinout/(it is not published to npm). - Themes: docs/theming/THEMING.md.
An add-on can only use the permissions ticked at install. run_process (programs on the computer) and screen_capture
(the picture of a device's screen) are shown with a warning.
An experimental Android viewer is in android/. It pairs directly with another Android 11+ device and displays its screen. Packaging exports an unsigned APK by default, or a signed APK when the Android signing secrets are configured.
Requirements: Rust (stable), Node.js, and the
system libraries Tauri 2 needs (on Windows the MSVC build tools and WebView2;
on Linux libwebkit2gtk-4.1-dev, libayatana-appindicator3-dev, …).
Windows builds also need the .NET 8 SDK (or a later SDK that can target .NET 8) for the isolated widget provider.
The installer and portable executable embed its self-contained payload; end users need no separate .NET or Widgets SDK
installation. Docker supplies the build SDK automatically, only for the Windows target.
npm install
npm run tauri dev # run, rebuilding when a file changes
npm run tauri build # the program and the installer for this system
npm run package # Docker: Linux, Windows, Android APK and add-on types, into out/
npm run package -- --sequential # Build the three targets in turn on machines with less memory
Tests use a fake adb and a fake scrcpy (src-tauri/examples/) and need no device:
cd src-tauri && cargo clippy --all-targets && cargo test
npx tsc --noEmit && npm run check:locales
Problems are reported on the Issues page. A report is most useful with the version of the program, the operating system, the steps that lead to the problem, and the relevant lines of the debug console. Device serial numbers, addresses and names should be removed from pasted text.
MIT. scrcpy is a project of Genymobile under the Apache License 2.0; this program is not affiliated with it.



