npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rootless-ssh

v1.1.5

Published

This package works as a workaround ssh by using websockets and child_process. It is suitable for people who can't have ssh on their server or don't have root access to install ssh.

Downloads

19

Readme

Rootless SSH

A npm package taking advantage of the execSync() of child_process to workaround SSH.

Specially made for replit users who can't pay for ssh access. Works on any device as long as it runs windows, linux or mac.

Prerequisites

  1. Installation of NodeJS (>=16)

Limitations

  1. Any command that reads line from terminal or asks for input doesn't work.
  2. You can only send a command when the previous one had responded.
  3. Any command that crashes node on your server will disconnect the websocket.

Server Side

This code would start a websocket on your port 3000 which can be connected to like this wss://<hostname>:3000

const { Server } = require('rootless-ssh');

const server = new Server({
    // these are default values
    welcomemsg: <advertisementText>, // if you don't want any welcome message, you have to explicitly set it to null.
    port: 3000, // optional if server is not null
    path: '/ssh',
    auth: 'changeme' // unique token that needs to be in the `authorization` header when connecting to websocket as `Bearer <password>`,
    server: <ExpressApp> /*or*/ <HttpServer>,
    logging: {
        input: false, // set to true to log commands
        output: false // set to true to log command outputs
    }
});

// to start the server
server.start();

// to close the server
server.stop();

// to access the underlying websocket instance
const ws = server.ws();

Note: Make sure to change the auth property as this can give an attacker access to your terminal. Even without root access, an attacker can do much damage to your system.

If you already have an express/http server, you can bind the websocket with it

// for express
const http = require('http'),
    express = require('express'),
    {Server} = require('rootless-ssh'),
    app = express(),
    server = http.createServer(app),
    ssh = new Server({},server); // you can put the options in {}

server.listen(3000);
ssh.start(); // recommended to start ssh after starting the server

Client Side

This code would connect to the websocket and you would be able to enter commands on your console.

const { Client } = require('rootless-ssh');

const client = new Client(url /* wss://<hostname>:<port> */,auth /* auth password */);

// to connect
client.connect();

// to disconnect
client.disconnect();

// additionally, you can send commands programmatically by using this
client.send("<commandString>");

// to access the underlying websocket connection
const ws = client.ws()

Custom Commands

Due to the technical limitations, we had to introduce some custom cli commands for certain works.

dirchange> : Works as a cd or chdir command. Same syntax.
disconnect> : Disconnects from the server.

Connecting from Command Line

Install this package as global npm i rootless-ssh -g

Now from console, run wssh "<host>" "<pass>" or npx wssh "<host>" "<pass>"

More commands will be introduced as we recieve requests.

Bugs

While this package is being actively tested, please know that bugs may appear. If you come across a bug, report in the issues tab on our github.