cli-flags
TypeScript icon, indicating that this package has built-in type declarations

2.0.7 • Public • Published

cli-flags

CircleCI codecov

CLI flag parser.

Usage:

const CLI = require('cli-flags')
 
const {flags, args} = CLI.parse({
  flags: {
    'output-file': CLI.flags.string({char: 'o'}),
    force: CLI.flags.boolean({char: 'f'})
  },
  args: [
    {name: 'input', required: true}
  ]
})
 
if (flags.force) {
  console.log('--force was set')
}
 
if (flags['output-file']) {
  console.log(`output file is: ${flags['output-file']}`)
}
 
console.log(`input arg: ${args.input}`)
 
// $ node example.js -f myinput --output-file=myexample.txt
// --force was set
// output file is: myexample.txt
// input arg: myinput

Readme

Keywords

Package Sidebar

Install

npm i cli-flags

Weekly Downloads

96

Version

2.0.7

License

ISC

Last publish

Collaborators

  • dickeyxxx