Giter VIP home page Giter VIP logo

command-line-commands's Introduction

view on npm npm module downloads per month Build Status Dependency Status js-standard-style

documentation in progress

command-line-commands

Add a git-like command interface to your app. Wraps command-line-args.

Example

const commandLineCommands = require('command-line-commands')

// define your commands
const cli = commandLineCommands([
  { name: 'help' },
  { name: 'run', definitions: [ { name: 'why', type: String } ] }
])

// parse the command line
const command = cli.parse()

// respond
switch (command.name) {
  case 'help':
    console.log("I can't help you.")
    break
  case 'run':
    console.log(`${command.options.why}: this is not a good reason.`)
    break
  default:
    console.log(command.error + ':' + command.command);

}

Output (assumes your app name is example):

$ example help
I can't help you.

$ example run --why terror
terror: this is not a good reason.

$ example hide
Unknown command: hide

CommandLineCommands ⏏

Kind: Exported class

new CommandLineCommands(commands)

Param Type
commands array

commandLineCommands.parse([argv]) ⇒ object

Kind: instance method of CommandLineCommands

Param Type
[argv] array

© 2015 Lloyd Brookes <[email protected]>. Documented by jsdoc-to-markdown.

command-line-commands's People

Contributors

75lb avatar lipsumar avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.