trzsz2

中文 | English

trzsz.js's derivative project providing a pure protocol implementation for Node.js and browser environments.

Notice

This project is based on trzsz-js by Lonny Wong.

All credits for the original trzsz protocol implementation go to Lonny Wong. This is a derived work that:

• Removes file system (fs) and browser-specific dependencies from the original codebase
• Focuses on providing a pure protocol implementation suitable for Node.js environments
• Maintains compatibility with browser usage through the browser build

Installation

npm install trzsz2

Building from Source

# Clone the repository
git clone https://github.com/zxdong262/trzsz2.git
cd trzsz2

# Install dependencies
npm install

# Build all formats
npm run build

# Build specific format
npm run build:esm    # ESM only
npm run build:cjs    # CommonJS only
npm run build:cjs-full  # Bundled CommonJS
npm run build:browser  # Browser bundle

Testing

# Run unit tests
npm test

# Run integration tests (requires Docker)
npm run test:upload
npm run test:download

# Watch mode
npm run test:watch

Web Demo

The project includes a web demo located in src/web that demonstrates browser usage with xterm.js.

# Start the server (backend for SSH connections)
npm run server

# Start the development server (frontend with hot reload)
npm run dev:web

Related Projects

• trzsz-js - Original trzsz implementation with file system support by Lonny Wong
• trzsz - The main trzsz project
• electerm - Terminal/SSH/SFTP/FTP/Serial/VNC/RDP/Spice/Telnet client using this lib

License

MIT