deskreen README

The project's README from github.com/pavlobu/deskreen. As one markdown file: README.md.

Deskreen CE (Community Edition)

platform (Over 2M downloads during 5 years since launch)

Deskreen Logo

Deskreen turns any device with a web browser into a secondary screen for your computer

To learn more visit our website: deskreen.com

Donate to support Deskreen Open-Source

Deskreen is an electron.js based application that uses WebRTC to make a live stream of your computer screen to a web browser on any device. It is available for MacOS, Windows and Linux operating systems. The current open-source Community Edition version has limited features. If you need more features please consider upgrading to Pro version for more features when it is released.

▶️ See how people use Deskreen on Youtube (video tutorials, demos, use cases for Deskreen day to day usage)

Deskreen Frequently Asked Questions

Prerequisites

You will need to have node>=v23 npm>=10 installed.

  1. git clone this repo
  2. npm i
  3. cd ./src/client-viewer && npm i && cd ../..
  4. npm run clean && npm run build && npm run start -- run in prod like mode

for more npm scripts look at package.json

Starting with Custom Local IP

You can start Deskreen CE with a custom local IP address using the --local-ip or --ip CLI flag. This is useful when you want to specify a particular network interface IP address.

macOS

# Using open command (recommended)
open -a "Deskreen CE" --args --ip 192.168.1.100

# Or using the executable directly
/Applications/Deskreen\ CE.app/Contents/MacOS/Deskreen\ CE --ip 192.168.1.100

# Get your IP automatically and launch
open -a "Deskreen CE" --args --ip "192.168.1.100"

Windows

# Using Start-Process (PowerShell)
Start-Process "Deskreen CE" -ArgumentList "--ip", "192.168.1.100"

# Or using the executable directly
"C:\Program Files\Deskreen CE\Deskreen CE.exe" --ip 192.168.1.100

# Or from Command Prompt
start "" "C:\Program Files\Deskreen CE\Deskreen CE.exe" --ip 192.168.1.100

Linux

# If installed via AppImage
./Deskreen\ CE-*.AppImage --ip 192.168.1.100

# If installed via .deb/.rpm package (usually in /usr/bin or /opt)
deskreen-ce --ip 192.168.1.100

# Or using full path
/opt/Deskreen\ CE/deskreen-ce --ip 192.168.1.100

Note: Replace 192.168.1.100 with your actual local IP address. You can find your IP using:

When using the --ip or --local-ip flag, the app will use the specified IP for QR codes and connection URLs, while still monitoring the actual network interface status for WiFi connection detection.

Maintainer

License

AGPL-3.0 License © Pavlo (Paul) Buidenkov

Electron-Vite MIT License © electron-vite

React MIT License © Facebook, Inc. and its affiliates

Vite MIT License © Vite.js

Electron Builder MIT License © electron-builder contributors

Apache 2.0 © blueprintjs

simple-peer MIT. Copyright © Feross Aboukhadijeh

tweetnacl ISC License © Dmitry Chestnykh, Devi Mandiri, and contributors (https://github.com/dchest/tweetnacl-js)

darkwire.io MIT License © darkwire/darkwire.io

And many many others...

Thanks

🙏 Many thanks to all 🌍 open source community members and maintainers of libraries used in this project.

deskreen (pavlobu/deskreen)

Searching Database…

21.6K ·GitHub
Deskreen
这是干什么的?Deskreen 可以把任何带网页浏览器的设备——手机、平板或笔记本——变成你电脑的第二块屏幕。它是一个 Electron 应用,通过 WebRTC 实时串流你的屏幕画面。
也就是说 Deskreen 只装在我的电脑上,另一台设备只要打开浏览器就行?没错。应用只装在电脑上;另一台设备除了浏览器什么都不需要——打开连接网址,或者扫描 Deskreen 显示的二维码即可。
我怎么把它跑起来?社区版(Community Edition)需要从源码构建:克隆仓库,运行 npm i,安装客户端查看器的依赖,然后执行 npm run clean && npm run build && npm run start。项目官网是 deskreen.com。
构建之前我需要装好什么?Node.js v23 或更新版本,以及 npm 10 或更新版本。其他东西都会在安装步骤中由 npm 自动拉取。
免费版是不是缺了些什么?是的——开源的社区版(Community Edition)功能有限。README 建议需要更多功能的话可以关注即将推出的 Pro 版,但它还没有发布,功能列表也没有公布。
它支持哪些操作系统?macOS、Windows 和 Linux。查看端在任何网页浏览器里都能用,所以不管手机和平板是什么系统都没问题。
这是经过验证的成熟工具,还是个新实验?成熟工具:社区版(Community Edition)发布五年以来下载量已超过 200 万次。
我可以只共享某个应用窗口,而不是整个桌面吗?可以——项目自己的话题标签里同时列出了 'share-screen' 和 'share-app-window',说明除了全屏共享之外也支持单窗口共享。
我的电脑和另一台设备之间的画面传输是加密的吗?根据项目的元数据,是的:它带有 'end-to-end-encryption' 标签,而且致谢名单里包括 tweetnacl 和 darkwire.io,这些都是用于加密 WebRTC 的库。
它是用什么做的?Electron 上的 TypeScript,用 electron-vite 构建。界面用的是 React 加 Blueprint.js,WebRTC 走 simple-peer,加密由 tweetnacl 负责。
What are similar projects?webtorrent-desktop, PeerTube, dashbeam, streambert, lolPing, bitbang, ds-harness-remote, WebRTC-Experiment
Which topics is it in?electronjs, end-to-end-encryption, wifi, webrtc, video-streaming, qr-code, p2p, vite, app, agpl, electron, streaming
Creator
pavlobu
Size
11 MB
Stars
21.6K
Updated
CommitJul 08Releasev3.2.16Jul 08
Age
6y
Commits · 90 Days