npm install shell

Shell.js is sugar for parsing typical unix command line options.

• Reversibility, argument parser and stringifier
• Auto-discovery, extract unregistered options
• Standard and commands-based command lines (eg git pull ...)
• Unlimited/multi level commands (eg myapp server start ...)
• Type conversion ('string', 'boolean', 'integer', 'array')
• Object literals, config and parsed results are serializable and human readable
• Routing, run asynchronous functions or modules based on user commands
• Auto-generated help
• Complete tests coverages and samples

Documentation

• Usage
  • Displaying the help
  • Extended mode
  • Routing
• API
  • Method compile
  • Method help
  • Method helping
  • Method parse
  • Method route
• Configuration
  • Commands
  • Options
  • Load
  • Main parameter usage
  • Options configuration
  • Router property configuration
• Project
  • Changelog
  • License
  • Contribute

Contributors

The project is sponsored by Adaltas based in Paris, France. Adaltas offers support and consulting on distributed systems, big data and open source.