Skip to main content

Websocket remote debug terminal (auto sync workspace).

Project description

WSTerm

使用Websocket协议实现的远程终端,可以用于远程调试(支持自动同步本地工作区文件到远程机器)

支持环境

操作系统:

  • Linux
  • Windows
  • MacOS

Python 3.5以上版本

功能特性

  • 远程终端
  • 自动监听、同步工作区文件

为什么要使用WSTerm?

相比于SSH,Websocket协议具有更好的可访问性,很多场景下SSH服务不会被暴露出来,但是一般会暴露出Websocket服务。

SSH服务通常只支持Linux和MacOS,Windows需要安装独立的应用;而WSTerm可以直接运行在以上三种系统,使用更加方便。

自动同步本地工作区文件,可以实现本地修改代码,直接远程执行的特性,大大降低远程编写、执行代码的复杂性。

使用方式

安装方法

$ python3 -m pip install wsterm

服务端

$ wsterm --url ws://0.0.0.0:8080/terminal/ --server

此时,服务端会监听在本地的0.0.0.0:8080地址;如果只想监听在回环地址,可以将0.0.0.0替换成127.0.0.1

服务端还支持以下可选参数:

--token: 指定鉴权使用的Token

--log-level: 日志级别,默认为info

--log-file: 日志保存文件路径

-d/--daemon: 是否以daemon方式启动,默认为False

客户端

$ wsterm --url ws://1.2.3.4:8080/terminal/

客户端支持的可选参数:

--workspace: 需要同步的工作区目录

--token--log-level--log-file等参数与服务端相同

服务端与客户端需要指定相同的Token才能正常连接

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

wsterm-0.7.1.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

wsterm-0.7.1-py3-none-any.whl (4.4 MB view details)

Uploaded Python 3

File details

Details for the file wsterm-0.7.1.tar.gz.

File metadata

  • Download URL: wsterm-0.7.1.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for wsterm-0.7.1.tar.gz
Algorithm Hash digest
SHA256 0df3f2f8d6d76531f70e86637ed84272c9d73acbf9ccc002486aed0b795a583e
MD5 9ef01e63dfd2685f6dcae77a6ffc736a
BLAKE2b-256 4e12125d72df70e8813e72f69a568bf445fe66f940e16a3a6d8359e40e8b65fc

See more details on using hashes here.

File details

Details for the file wsterm-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: wsterm-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for wsterm-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 84d9c4ee78275c9b420e5d480a7e038044d89332dbab07ce4fef0c8a74c16713
MD5 3ee9fb4f079d78e2c788f5a6666105c9
BLAKE2b-256 cb9c1f45125d2b11a1128fe8842bfbf7ee339bd51d2ab89b7b0e804db08cfa65

See more details on using hashes here.

Supported by

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