{"id":28392771,"url":"https://github.com/zetxtech/wsterm","last_synced_at":"2025-06-26T07:31:19.516Z","repository":{"id":288120041,"uuid":"966885727","full_name":"zetxtech/wsterm","owner":"zetxtech","description":"A WebSocket-based terminal sharing tool that allows you to securely expose and share your terminal (TTY) over any network, even through NATs.","archived":false,"fork":false,"pushed_at":"2025-04-16T04:54:57.000Z","size":19,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-01T02:08:18.133Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zetxtech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-15T15:45:47.000Z","updated_at":"2025-04-20T04:01:13.000Z","dependencies_parsed_at":"2025-04-15T17:35:16.485Z","dependency_job_id":"fed5caa1-7030-4af3-a755-c5be84c67aee","html_url":"https://github.com/zetxtech/wsterm","commit_stats":null,"previous_names":["zetxtech/wsterm"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/zetxtech/wsterm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwsterm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwsterm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwsterm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwsterm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zetxtech","download_url":"https://codeload.github.com/zetxtech/wsterm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zetxtech%2Fwsterm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262022121,"owners_count":23246264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-31T15:08:11.696Z","updated_at":"2025-06-26T07:31:19.509Z","avatar_url":"https://github.com/zetxtech.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WSTerm\n\nA powerful WebSocket-based terminal sharing tool that allows you to securely expose and share your terminal (TTY) over any network, even through firewalls and NATs.\n\n## Features\n\n- Server mode: Expose your shell securely to clients through WebSockets\n- Client mode: Connect to remote terminals with interactive access\n- Intranet penetration via WSSocks: Share terminals through firewalls/NAT using secure tunneling\n\n## Installation\n\nWSTerm can be installed by:\n\n```bash\ngo install github.com/zetxtech/wsterm/cmd/wsterm@latest\n```\n\nYou can also download pre-built binaries for your architecture from the [releases page](https://github.com/zetxtech/wsterm/releases).\n\nWSTerm is also available via Docker:\n\n```bash\ndocker run --rm -it jackzzs/wsterm --help\n```\n\n## Usage\n\nThe application supports both direct connections and tunneled connections through WSSocks:\n\n### Quick Start with WSSocks (Recommended)\n\nShare your terminal through any network/firewall:\n\n```bash\n# On the server (machine sharing the terminal):\nwsterm server -t YOUR_TOKEN\n\n# On the client (machine accessing the terminal):\nwsterm client -t YOUR_TOKEN\n```\n\nThis method works everywhere - no port forwarding or firewall configuration needed!\n\nYou should use a complex token, as anyone holding the token can connect to your terminal.\n\n```bash\nopenssl rand -hex 16\n```\n\n### Direct Connection Mode\n\nFor local network or when you have direct access:\n\n#### Server Mode\n\n```bash\n# Basic usage\n./wsterm server --port 8080 --host localhost\n\n# Accept connections from any interface\n./wsterm server --port 8080 --host 0.0.0.0\n\n# Specify a custom shell\n./wsterm server --shell /bin/zsh\n```\n\n#### Client Mode\n\n```bash\n# Connect to local server\n./wsterm client --url ws://localhost:8080\n\n# Connect to remote server\n./wsterm client --url ws://example.com:8080\n\n# Use with proxy\n./wsterm client --proxy socks5://proxy.example.com:1080\n```\n\n## License\n\nMIT ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzetxtech%2Fwsterm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzetxtech%2Fwsterm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzetxtech%2Fwsterm/lists"}