sshx: Fast, Collaborative Live Terminal Sharing Over the Web

Introduction

sshx is a secure, web-based, collaborative terminal developed by ekzhang. It allows users to share their terminal sessions with others over the web quickly and securely. Built with Rust, sshx provides a robust platform for real-time collaboration, featuring an infinite canvas for multiple windows, real-time cursor tracking, and end-to-end encryption.

Key features include:

• Run a single command to share your terminal with anyone.
• Resize, move windows, and freely zoom and pan on an infinite canvas.
• See other people's cursors moving in real time.
• Connect to the nearest server in a globally distributed mesh.
• End-to-end encryption with Argon2 and AES.
• Automatic reconnection and real-time latency estimates.
• Predictive echo for faster local editing (à la Mosh).

Installation

Getting started with sshx is straightforward. You can install the sshx binary for your platform with a simple curl command:

curl -sSf https://sshx.io/get | sh

This command supports Linux and macOS on x86_64 and ARM64 architectures, as well as embedded ARMv6 and ARMv7-A systems. For Windows, binaries are available for x86_64, x86, and ARM64.

If you prefer to try it out without a full installation, use:

curl -sSf https://sshx.io/get | sh -s run

macOS users can also install sshx using Homebrew:

brew install sshx

Examples

sshx is particularly useful for debugging and collaboration, even in automated environments like CI/CD pipelines. Here's an example of how to integrate sshx into a GitHub Actions workflow:

name: CI
on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      # ... other steps ...

      - run: curl -sSf https://sshx.io/get | sh -s run
      #      ^
      #      ? This will open a remote terminal session and print the URL. It
      #        should take under a second.

This allows you to get a live terminal session for a running CI job, which can be invaluable for diagnosing complex issues. Remember to exercise caution when using this in public repositories, as logs of CI jobs are often publicly viewable.

Why Use sshx?

sshx stands out as a powerful tool for several reasons:

• Seamless Collaboration: Share your terminal instantly for pair programming, remote debugging, or educational purposes, with real-time cursor visibility.
• Enhanced Security: Benefit from end-to-end encryption using Argon2 and AES, ensuring your sessions are private and secure.
• Global Performance: Connect to the nearest server in a globally distributed mesh, providing low latency and a smooth experience.
• Ease of Access: Share and access terminal sessions directly through a web browser, eliminating the need for complex client installations for collaborators.
• Developer-Friendly: Built with Rust, it offers a robust and efficient solution, with features like predictive echo for a responsive local editing experience.

Links

• GitHub Repository: https://github.com/ekzhang/sshx
• Official Website: https://sshx.io