Stumble-cli NPM

`stumble-cli`

A thin CLI wrapper for running stumble instances.

Install

Using npm.

$ npm install -g stumble-cli

Usage

Installing the package globally provides a stumble executable. This executable has two sub commands, help and run (the default command if no valid command is given).

$ stumble help

results in:

Stumble CLI

[ Multiple: Off ][ Reruns: Off ][ Warnings: On ]

[ help ] Display this message.

[ run ] (default) This starts a Stumble instance, and connects to the server specified in the configuration.
  --config, -c  
    A valid path to a Stumble JSON configuration file.
  --timeout, -t  (default: 1500)
    Time in milliseconds to wait for connection to come back after a disconnect, before exiting the process.

We can see from the previous result that

$ stumble --config my_config.json

will run a new Stumble instance, loading the configuration file specified. We can optionally adjust the delay in awaiting a reconnect in the event that the instance loses connection.

Note that relative paths in the config file resolve relative to the current working directory, not the directory housing the config file. When unsure, use absolute paths.

The executable provides no way to facilitate loading third-party extensions, and is currently intended to be used with a stock stumble, and its Standard Extension Library.

Enjoy!

9 years ago

9 years ago