README
¶
LinkTerm
A 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. The server runs on Linux, macOS, Windows (via ConPTY), FreeBSD and other Unix-like systems.
Quick Start
Share your terminal through any network/firewall:
# On the server (machine sharing the terminal):
linkterm server -t YOUR_TOKEN
# On the client (machine accessing the terminal):
linkterm client -t YOUR_TOKEN
This method works everywhere - no port forwarding or firewall configuration needed!
You should use a complex token, as anyone holding the token can connect to your terminal.
openssl rand -hex 16
The connection is proxied via our public server: https://l.zetx.tech using Linksocks. You can also host your Linksocks server on Cloudflare Workers: linksocks/linksocks.js
Direct Connection Mode
For local network or when you have direct access:
Server:
# Host server at 8080
./linkterm server --port 8080 --host localhost
Client:
# Connect to local server
./linkterm client --url ws://localhost:8080
Installation
LinkTerm can be installed by:
go install github.com/linksocks/linkterm/cmd/linkterm@latest
You can also download pre-built binaries for your architecture from the releases page.
LinkTerm is also available via Docker:
docker run --rm -it jackzzs/linkterm --help
License
MIT
Directories