https://github.com/pavlobu/deskreen
Deskreen turns any device with a web browser into a secondary screen for your computer. ⭐️ Star to support our work!
https://github.com/pavlobu/deskreen
blueprintjs darkwire-io deskreen easy-to-use electon-app electron electron-react-boilerplate electronjs end-to-end-encryption linuxapp macosapp sceen-sharing-to-multiple-devices second-screen share-app-window share-screen testcafe typescript webrtc wifi windowsapp
Last synced: 19 days ago
JSON representation
Deskreen turns any device with a web browser into a secondary screen for your computer. ⭐️ Star to support our work!
- Host: GitHub
- URL: https://github.com/pavlobu/deskreen
- Owner: pavlobu
- License: agpl-3.0
- Created: 2020-08-08T13:24:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2026-01-25T12:54:17.000Z (about 1 month ago)
- Last Synced: 2026-02-01T01:11:28.496Z (26 days ago)
- Topics: blueprintjs, darkwire-io, deskreen, easy-to-use, electon-app, electron, electron-react-boilerplate, electronjs, end-to-end-encryption, linuxapp, macosapp, sceen-sharing-to-multiple-devices, second-screen, share-app-window, share-screen, testcafe, typescript, webrtc, wifi, windowsapp
- Language: TypeScript
- Homepage: https://deskreen.com
- Size: 10.8 MB
- Stars: 20,161
- Watchers: 253
- Forks: 1,130
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-GitHub-Repo - deskreen - 将任何设备转换为电脑的辅助屏幕。[<img src="https://tva1.sinaimg.cn/large/008i3skNly1gxlhtmg11mj305k05k746.jpg" alt="微信" width="18px" height="18px" />](https://mp.weixin.qq.com/s?__biz=MzUxNjg4NDEzNA%3D%3D&chksm=f9a2276dced5ae7b800b7ecda3d5bedf98aa74dfd422c5272f1a5b168b820728dbc2890faa30&idx=1&mid=2247496868&scene=21&sn=aa69f8a60c2dfb5cde294137c1c89d02#wechat_redirect) (开源工具 / 好用工具)
- awesome-starred - pavlobu/deskreen - Deskreen turns any device with a web browser into a secondary screen for your computer. ⭐️ Star to support our work! (electron)
- StarryDivineSky - pavlobu/deskreen
- awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/pavlobu/deskreen - Turn web browser into a secondary screen (Useful)
- awesome-repository - pavlobu / deskreen
- fucking-awesome-privacy - Deskreen - Turn any device into a secondary screen for your computer. (Utilities / Imgur)
- awesome-privacy - Deskreen - Turn any device into a secondary screen for your computer. (Utilities / Imgur)
- starred - pavlobu/deskreen - Deskreen turns any device with a web browser into a secondary screen for your computer. ⭐️ Star to support our work! (TypeScript)
- awesome-webrtc - Deskreen - Turns any device with a web browser into a secondary screen for your computer. (Projects / Screen)
- awesome-starts - pavlobu/deskreen - Deskreen turns any device with a web browser into a secondary screen for your computer (TypeScript)
README
# Deskreen CE (Community Edition)
(Over 2M downloads during 5 years since launch)
## Deskreen turns any device with a web browser into a secondary screen for your computer
## To learn more visit our website: [deskreen.com](https://deskreen.com)
## [Donate to support Deskreen Open-Source](https://deskreen.com/#contribute)
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](https://deskreen.com/download) version for more features when it is released.
---
### ▶️ [See how people use Deskreen on Youtube](https://www.youtube.com/results?search_query=deskreen) (video tutorials, demos, use cases for Deskreen day to day usage)
---
## [Deskreen Frequently Asked Questions](https://deskreen.com/faq)
---
### Prerequisites
You will need to have `node>=v23` `pnpm>=v10.20.0` installed.
1. git clone this repo
2. `pnpm i`
3. `cd ./src/client-viewer && pnpm i && cd ../..`
4. `pnpm clean && pnpm build && pnpm start` -- run in prod like mode
#### for more pnpm commands 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
```bash
# 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
```powershell
# 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
```bash
# 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:
- **macOS/Linux:** `ipconfig getifaddr en0` or `ifconfig | grep "inet "`
- **Windows:** `ipconfig` (look for IPv4 Address)
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
- [Pavlo (Paul) Buidenkov](https://www.linkedin.com/in/pavlobu)
## License
AGPL-3.0 License © [Pavlo (Paul) Buidenkov](https://github.com/pavlobu/deskreen)
## Copyright
Electron-Vite MIT License © [electron-vite](https://github.com/alex8088/electron-vite)
React MIT License © [Facebook, Inc. and its affiliates](https://github.com/facebook/react)
Vite MIT License © [Vite.js](https://github.com/vitejs/vite)
Electron Builder MIT License © [electron-builder contributors](https://github.com/electron-userland/electron-builder)
Apache 2.0 © [blueprintjs](https://github.com/palantir/blueprint)
simple-peer MIT. Copyright © [Feross Aboukhadijeh](http://feross.org/)
tweetnacl ISC License © Dmitry Chestnykh, Devi Mandiri, and contributors (https://github.com/dchest/tweetnacl-js)
darkwire.io MIT License © [darkwire/darkwire.io](https://github.com/darkwire/darkwire.io)
And many many others...
## Thanks
🙏 Many thanks to all 🌍 open source community members and maintainers of libraries used in this project.