gui-remote-controll 0.1.4

Cross-platform remote desktop control from a web browser.

GUI Remote Controll

中文

GUI Remote Controll shares a Windows, Linux, or macOS desktop with a web browser. The browser receives screen frames and can redirect mouse, touch, wheel, keyboard, text input, and plain-text clipboard events to the server computer.

Quick Start

Python 3.10 or newer is required.

1. Install the package:

   pip install gui-remote-controll
   

2. Start a PIN-protected server:

   gui-remote-controll --pin 123456 --title "Office workstation"
   

   Startup requests administrator/root privileges once. Use --no-elevate only when the desktop permissions have already been configured or elevation is inappropriate. Omit --title to use GUI Remote Controll.

3. Open the control page:

   • On the server computer: http://127.0.0.1:8000
   • On the local network: http://SERVER_LAN_IP:8000

The default bind address is 0.0.0.0. Always set --pin when another device can reach the server. Use TLS or an encrypted tunnel outside a trusted LAN, and never expose the default HTTP service directly to the public internet.

First-run permissions

• Windows: accept the UAC prompt. Run the server from the signed-in interactive session.
• Linux: use an X11 desktop session. Native Wayland does not permit portable global capture and input injection.
• macOS: grant Screen Recording and Accessibility permissions to the terminal or Python executable, then restart the server. Root access does not replace these permissions.

See the platform guide for setup and troubleshooting details.

Documentation

• Documentation index
• Complete user guide
• CLI reference
• Architecture and algorithms
• Platform support
• Development and release guide
• Changelog
• Security policy

The Python import package is gui_remote_controll. The PyPI distribution and command name intentionally follow the repository spelling, gui-remote-controll.

License

MIT