Skip to main content

Professional Python client and host utilities for Terminal Tool

Project description

Terminal Tool Python (terminal-tool-py)

A robust, cross-platform remote terminal sharing solution that allows you to host local shells and connect to them securely via a central relay server. Built for developers, sysadmins, and power users who need high-performance remote access without the complexity of traditional VPNs or SSH tunnels.

🚀 Key Features

  • Unique Machine Tokens: Automated authentication using unique tokens generated from HWID + Public IP. No more repeating passwords for trusted machines.
  • Real-time Screen Sharing: View your remote PC's screen directly from the terminal or mobile app.
  • Admin Shell Support: Toggle elevated privileges (sudo/runas) for your remote sessions.
  • Cross-Platform: Fully compatible with Windows 10/11, Linux, and macOS.
  • High Performance: Powered by Protocol Buffers (protobuf) and optimized WebSockets for low-latency command execution.

📦 Installation

Install the base package:

pip install terminal-tool-py

Windows Users

To enable native PTY (Terminal) support on Windows, install the optional dependencies:

pip install terminal-tool-py[windows]

Screen Sharing

To enable the live screen sharing feature, ensure you have the screen capture dependencies:

pip install pyautogui pillow

🛠 Usage

1. Register a Host

Expose your local machine to the relay server:

term-start host --server https://terminal-tool.onrender.com --password YOUR_ADMIN_PASS

Options:

  • --host-id: Provide a custom stable ID (e.g., my-desktop).
  • --no-discord: Disable the default Discord monitoring notification.
  • --shell: Override the default shell (Powershell, bash, zsh).

2. Connect as a Client

Access a remote host from another machine:

term-start client --server https://terminal-tool.onrender.com --host-id my-desktop

3. List Hosts

Discover active hosts on the relay:

term-start hosts --server https://terminal-tool.onrender.com

🔐 Security & Privacy

  • Machine Tokens: Upon first registration, the relay generates a unique machine token. Keep this token safe as it allows reconnection without requiring the admin password.
  • Telemetry: By default, starting a host sends a registration notification to a public Discord webhook for monitoring. Use the --no-discord flag if you wish to opt-out.
  • Encryption: Communication is handled via WebSockets; ensure your relay server is configured with TLS/SSL (HTTPS/WSS) for end-to-end security.

📜 License

Distributed under the MIT License. See LICENSE for more information.


Main Website: terminal-tool.onrender.com
GitHub Repository: BaHost01/Terminal-Tool

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terminal_tool_py-1.1.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terminal_tool_py-1.1.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file terminal_tool_py-1.1.0.tar.gz.

File metadata

  • Download URL: terminal_tool_py-1.1.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for terminal_tool_py-1.1.0.tar.gz
Algorithm Hash digest
SHA256 437da6a3df37d2511ae3e85ab05dbc8086651e17621bc6f2a80a9b19f2d39485
MD5 e6b5f2c385f8b3b013c5b7a12bf56264
BLAKE2b-256 518dd01c28f198967a7351b4f015392e2dfb7656dd872987647af6a6f99f2f28

See more details on using hashes here.

File details

Details for the file terminal_tool_py-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for terminal_tool_py-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8967e3ecc54b9e73289253bd64c64d9f95ea339643665310b4967640da59fef
MD5 ebd0453dc7664cb564568091330b0624
BLAKE2b-256 7c2b8601edf93cbc7075ccedd168b12f864adecf9e6eb8aa7b25ba995491399d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page