search

aichaos / rivescript-js

A RiveScript interpreter for JavaScript. RiveScript is a scripting language for chatterbots.
https://www.rivescript.com/
MIT License
377 stars 145 forks source link

Make interactive shell easily available when installing via npm #330

Closed ErwanDL closed 4 years ago

ErwanDL commented 4 years ago

Following our discussion on #329, I made the interactive shell available as a command-line tool when installing rivescript-js via npm (there was actually very little change to make, only a few additions to package.json). I chose to call the associated command "riveshell", tell me if you'd prefer another name.

It can be called via $ npx riveshell /path/to/brain when the package is installed locally, or simply $ riveshell /path/to/brain when installed globally. I ensured that the command works properly both on macOS (bash) and Windows (cmd, powershell and git-bash).

I also updated the README.md file and the doc at the top of shell.js to reflect this new feature. I moved the "Installation" section of the README above the "Usage" section because I assume that people should already have installed the package before reading the details on how to use the interactive shell.

ErwanDL commented 4 years ago

Hi @kirsle do you think this PR could be merged anytime soon ? 😃

kirsle commented 4 years ago

Hi @ErwanDL

I've merged this now and published it as v2.1.0 on npm. :smile: Thanks!