Just Screen Share - Share your screen with a public URL
Project description
JS2 - Just Screen Share
Share your screen with friends using a simple command and public URL.
Quick Start
# Install
pip install -e .
# Share your screen (one command!)
js2 publish
That's it! You'll get a public URL to share with friends.
Features
- One command to share:
js2 publish - Public URL via ngrok tunnel
- View-only (no remote control)
- Works on macOS, Windows, Linux
- Browser-based viewer (friends don't need to install anything)
Requirements
- Python 3.8+
Installation
# Clone this repo
cd js2
# Install js2 and all dependencies
pip install -e .
Usage
Share with Public URL (Recommended)
js2 publish
This will:
- Start the screen capture server
- Create an ngrok tunnel
- Give you a public URL to share
Local Only
js2 start
Starts server on http://localhost:8080 without tunneling.
Commands
| Command | Description |
|---|---|
js2 publish |
Start and get public URL (uses ngrok) |
js2 start |
Start locally only |
js2 --help |
Show help |
ngrok Authentication (First Time Only)
If ngrok asks for authentication:
- Create a free account at https://ngrok.com
- Get your authtoken from https://dashboard.ngrok.com/get-started/your-authtoken
- Run:
ngrok authtoken YOUR_TOKEN
After this one-time setup, js2 publish will work automatically.
How It Works
Your Screen --> [JS2 Server] --> [ngrok tunnel] --> [Public URL] --> Friend's Browser
- JS2 captures your screen
- Streams it via WebSocket
- ngrok creates a public tunnel
- Friends open the URL in any browser
Troubleshooting
macOS: "Permission denied" for screen recording
Go to: System Preferences > Security & Privacy > Privacy > Screen Recording Add your terminal app to the allowed list.
ngrok authentication error
Run: ngrok authtoken YOUR_TOKEN
Get your token at: https://dashboard.ngrok.com/get-started/your-authtoken
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file js2-0.1.0.tar.gz.
File metadata
- Download URL: js2-0.1.0.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
18d76bb1112d298e433aafdda3bfe94add5004583e43497583248b0bef9fb7d6
|
|
| MD5 |
b44e5d21f31bc05598958724870fa436
|
|
| BLAKE2b-256 |
8b2f00c320096aebaf465365a377663c8c37c547c839d4464f00ebc8dd62cc03
|
File details
Details for the file js2-0.1.0-py3-none-any.whl.
File metadata
- Download URL: js2-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
94f887e1c321151ae10b66d857d75a5831b1c5ee1b7cae64e4bb759ce3bfdd2f
|
|
| MD5 |
86cc2ba300436d699f7c3291580d85e5
|
|
| BLAKE2b-256 |
c3e72bbc7f78caecc5a026e3e86cd53703e4ca7c76be84472768445102d131b4
|