RuTTY - Rust TTY Server
Demo
RuTTY (aka Ruthie) is a CLI-powered websocket server written in Rust that allows you to expose your commands via browser. RuTTY was written with the sole-purpose of me wanting to expermient with Rust.
How it works?
RuTTY was heavily inspired by a very similar tool written in Go, called GoTTY.
RuTTY run a command for each client connection, forwards the TTY stdout to the client, and forwards the client input to the TTY stdin. RuTTY uses xterm.js to show a TTY display on the webpage.
Installtion
cargo install rutty
Usage
To run rutty simply run rutty and add your command and any optional arguments to that command, e.g. rutty vi test.txt.
Options
| Option | Description | Default |
|---|---|---|
| -address (-a) | Server listening IP address | 0.0.0.0 (All interfaces) |
| -port (-p) | Server listening port | 3000 |
| -allow-write (-w) | Wether clients are allowed to pass input | false |
| --title (-t) | HTML page title | RuTTY Server |
| --reconnect (-r) | Automatic reconnection delay | None (no automatic reconnection) |
Development
Clone the repository, install rust, node & yarn.
Build
Debug build: make build.
Release build: make build release=1
Run
cargo run -- <COMMAND> <ARGS>
Web development
An automatic hot-reload of the static files can be done by running yarn start inside the web directory, which will use parcel to start a development server on http://localhost:1234 that is proxied to your RuTTY server running on port 3000.
License
MIT
55 Dec 30, 2022
12 Nov 12, 2022
158 Mar 9, 2023
259 Jan 3, 2023
4 Jun 25, 2023
6 Jul 10, 2023
26 Jan 13, 2023
30 Dec 29, 2022
79 Jan 4, 2023
3 Nov 18, 2021
0 Jan 9, 2022
16 Dec 1, 2022
18 Nov 30, 2022
20 Dec 15, 2022
496 Jan 2, 2023
11 Oct 17, 2022
55 Jan 22, 2023
4 Mar 19, 2023
4 Nov 9, 2023
1.3k Jan 6, 2023
1.3k Jan 8, 2023
1.3k Jan 2, 2023
39 Nov 20, 2022
191 Dec 20, 2022
19 Aug 22, 2022
8 Sep 7, 2022
12 Oct 3, 2022
1 Feb 14, 2022