TShare is both an executable binary that can be run, and a library that can be used in Rust programs.
Installing the command-line executable
Assuming you have Rust/Cargo installed , run this command in a terminal:
cargo install tshare
It will make the tshare command available in your PATH if you've allowed the PATH to be modified when installing Rust . cargo uninstall tshare uninstalls.
Adding tshare library as a dependency
Run this command in a terminal, in your project's directory:
cargo add tshare
To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:
tshare = "1.0.5"
The tshare library will be automatically available globally.
Read the tshare library documentation .
Back to the crate overview .
Readme
TShare
Collaborative terminal sharing.
Screenshots
Requirements
Rust (any recent version)
Development dependencies:
just (cargo install just )
djlint (pip install djlint ) for HTML formatting
Installation
Download pre-built packages from the releases page or build from source:
cargo build -- release
# Binaries will be in target/release/
Usage
Start servers:
tshare tunnel &
tshare web &
Share terminal:
tshare connect
Development
See justfile for available commands:
just -- list
Common commands:
just run # Start both servers
just client connect # Create session
just build # Build release
just build-deb # Build .deb package
Architecture
tshare : CLI client, captures terminal sessions
tshare tunnel : WebSocket relay and API, port 8385
tshare web : Web interface, port 8386
Configuration
All binaries accept --help for options. Default configuration works for local development.
Production example:
tshare tunnel -- host 0.0.0.0
tshare web -- host 0.0.0.0 -- tunnel-url http://tunnel.example.com:8385
tshare connect -- tunnel-host tunnel.example.com -- web-host web.example.com
License
MIT