node package manager
It’s your turn. Help us improve JavaScript. Take the 2017 JavaScript Ecosystem Survey »


Console (REPL) for SocketStream 0.3 apps

Allows you to connect to a running SocketStream server to call commands such as ss.rpc() or ss.publish.all() from the terminal. This can be very useful when debugging your app.

The SocketStream console follows the client/server model. This ensures the console client starts instantly and even allows you to run commands against a live production system, should you wish.

Important Note The latest release of ss-console (0.1.3) is designed to work with Node 0.8 only. If you are using Node 0.6 please install version 0.1.2 from npm.


Add ss-console to your package.json then add the following lines to your app.js file:

var consoleServer = require('ss-console')(ss);

Change 5000 to another number if you wish to listen on another port.

Connecting to a server

Install the client globally with:

$ sudo npm install -g ss-console

Once your server is listening out for incoming console connections, connect to it from the terminal by executing:

$ ss-console

By default ss-console will try to connect to a SocketStream server on localhost, port 5000. To connect to another host and/or port, pass params as so:

$ ss-console 8500

Note: A new Session ID will be created for you each time you connect to the console, allowing you to call ss.rpc() commands which use the req.use('session') middleware.