trzsz
v1.1.5
Published
Making webshell and terminal supports trzsz ( trz / tsz ), which similar to ( rz / sz ), and compatible with tmux.
Downloads
5,572
Maintainers
Readme
trzsz.js
Making webshell and terminal supports trzsz ( trz / tsz ), which similar to ( rz / sz ), and compatible with tmux.
Website: https://trzsz.github.io/js 中文文档:https://trzsz.github.io/cn/js
Please check https://trzsz.github.io for more information of trzsz
.
trzsz.js
is the js
version of trzsz
, supports webshell running in browser, terminal built with electron, etc.
Getting Started
Install the module
npm install trzsz
or
yarn add trzsz
Use in Node.js
import { TrzszFilter } from "trzsz";
or
const { TrzszFilter } = require("trzsz");
Use in browser
<script src="node_modules/trzsz/lib/trzsz.js"></script>
Create
TrzszFilter
object for each connection.const trzszFilter = new TrzszFilter({ // The trzsz options, see below });
Generally, the output of the server is forwarded to the terminal. Pass the output through
TrzszFilter
.const trzszFilter = new TrzszFilter({ // The output will be forwarded back by TrzszFilter, unless the user runs ( trz / tsz ) on the server. writeToTerminal: (data) => terminal.write(typeof data === "string" ? data : new Uint8Array(data)), }); // forward the output to TrzszFilter webSocket.addEventListener("message", (ev) => trzszFilter.processServerOutput(ev.data));
Generally, the user input is forwarded to the server. Pass the user input through
TrzszFilter
.const trzszFilter = new TrzszFilter({ // The user input will be forwarded back by TrzszFilter, unless there are files being transferred. sendToServer: (data) => webSocket.send(data), }); // forward the user input to TrzszFilter terminal.onData((data) => trzszFilter.processTerminalInput(data)); // forward binary input to TrzszFilter terminal.onBinary((data) => trzszFilter.processBinaryInput(data));
Let
TrzszFilter
know the terminal columns for rendering progress bar.const trzszFilter = new TrzszFilter({ // initialize the terminal columns terminalColumns: terminal.cols, }); // reset the terminal columns terminal.onResize((size) => trzszFilter.setTerminalColumns(size.cols));
If the remote server is a Windows shell, such as
cmd
andPowerShell
.const trzszFilter = new TrzszFilter({ // There is a windows shell isWindowsShell: true, });
If running in
Node.js
andTrzszFilter
canrequire('fs')
,chooseSendFiles
andchooseSaveDirectory
are required. If running in web browser, they will be ignored. Note that they areasync
functions.const trzszFilter = new TrzszFilter({ // call on the user runs trz ( upload files ) on the server and no error on require('fs'). chooseSendFiles: async (directory) => { // if `directory` is `true`, allow to choose multiple directories and files. // otherwise, only allow to choose multiple files. // return `undefined` if the user cancels. // return an array of file paths choosed by the user. return ["/path/to/file1", "/path/to/file2", "/path/to/directory3"]; }, // call on the user runs tsz ( download files ) on the server and no error on require('fs'). chooseSaveDirectory: async () => { // return `undefined` if the user cancels. // return a directory path choosed by the user. return "/path/to/directory"; }, });
Support dragging files or directories to upload.
terminalHtmlElement.addEventListener("dragover", (event) => event.preventDefault()); terminalHtmlElement.addEventListener("drop", (event) => { event.preventDefault(); trzszFilter .uploadFiles(event.dataTransfer.items) .then(() => console.log("upload success")) .catch((err) => console.log(err)); });
TrzszAddon
is a wrapper forTrzszFilter
. If you are using xterm-addon-attach, just replaceAttachAddon
withTrzszAddon
.import { Terminal } from "xterm"; import { TrzszAddon } from "trzsz"; const terminal = new Terminal(); const trzszAddon = new TrzszAddon(webSocket); terminal.loadAddon(trzszAddon);
Examples
Browser web shell example.
Electron terminal app example.
TrzszAddon xterm addon example.
Screenshot
upload and download files in web browser
upload and download files in electron app
Contact
Feel free to email the author [email protected], or create an issue. Welcome to join the QQ group: 318578930.
Sponsor
❤️ Sponsor trzsz ❤️, buy the author a drink 🍺 ? Thank you for your support!