~reesericci/turbowarp.sh

ssh but for scratch

#3 Interaction Handlers

~reesericci filed ticket on turbowarp.sh todo

9 months ago

b7c3f4c version increment

9 months ago

#turbowarp.sh

SSH over WebSockets for Scratch

Releases are available on NPM at https://www.npmjs.com/package/turbowarp.sh, and through various NPM CDNs (like jsDelivr).

To utilize this extension, load it through the "Custom Extension" option in TurboWarp extensions and paste in the URL from jsDelivr: https://cdn.jsdelivr.net/npm/turbowarp.sh@^1.0.0-rc7/dist/bundle.min.js

#docs

#connecting

SSH connections are tunneled over WebSockets, so they require a proxy on the receiving end to translate the WebSocket connection to TCP for sshd.

This proxy can be set up using websockify or websocat.

To specify the WebSocket proxy server, use the "connection with proxy" block:

connection [user]@[host] -i [identity file] with proxy [wss://] :: #859900

FYI: password authentication is not supported at this time, only SSH keys.

#executing commands

Commands are currently executed in independent sessions from one another, not inside of the same shell (see #1).

This means commands like cd won't actually do anything to the shell, they have to be attached to the same command with &&

Do:

execute (cd [example] && [do a thing]) :: #859900

Don't:

execute (cd [example]) :: #859900
execute (ls) :: #859900

#connection "objects"

Connections are passed around using the connection block, which outputs a base64 encoded version of the JSON that makes up the connection. These are then decoded by any block that uses the connection.

There is no shared state of all instantiated connections, only the current active connection is stored in the program. All other connections only exist in their encoded form.