https://github.com/adaltas/node-shell

Command line arguments parser and stringifier
https://github.com/adaltas/node-shell

arguments bash cli nodejs parameters parser shell terminal

Last synced: 3 days ago
JSON representation

Command line arguments parser and stringifier

• Host: GitHub
• URL: https://github.com/adaltas/node-shell
• Owner: adaltas
• License: mit
• Created: 2013-01-08T21:23:46.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-09-21T10:11:02.000Z (about 2 months ago)
• Last Synced: 2024-10-05T16:08:10.584Z (about 1 month ago)
• Topics: arguments, bash, cli, nodejs, parameters, parser, shell, terminal
• Language: CoffeeScript
• Homepage: https://shell.js.org
• Size: 11.3 MB
• Stars: 16
• Watchers: 13
• Forks: 5
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://secure.travis-ci.org/adaltas/node-shell.png)](http://travis-ci.org/adaltas/node-shell)

# `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](https://shell.js.org/usage/)

  - [Displaying the help](https://shell.js.org/usage/help/)

  - [Extended mode](https://shell.js.org/usage/extended/)

  - [Routing](https://shell.js.org/usage/routing/)

- [API](https://shell.js.org/api/)

  - [Method `compile`](https://shell.js.org/api/compile/)

  - [Method `help`](https://shell.js.org/api/help/)

  - [Method `helping`](https://shell.js.org/api/helping/)

  - [Method `parse`](https://shell.js.org/api/parse/)

  - [Method `route`](https://shell.js.org/api/route/)

- [Configuration](https://shell.js.org/config/)

  - [Commands](https://shell.js.org/config/commands/)

  - [Options](https://shell.js.org/config/options/)

  - [Load](https://shell.js.org/config/load/)

  - [Main parameter usage](https://shell.js.org/config/main/)

  - [Options configuration](https://shell.js.org/config/options/)

  - [Router property configuration](https://shell.js.org/config/router/)

- [Project](https://shell.js.org/project/)

  - [Changelog](https://shell.js.org/project/changelog/)

  - [License](https://shell.js.org/project/license/)

  - [Contribute](https://shell.js.org/project/contribute/)