Sergeant NPM | npm.io

29.1.0 • Published 3 years ago

Install

Weekly downloads

7

License

ISC

Repository

Last release

3 years ago

sergeant

A CLI solution with simple argument parsing, sub-commands, and built in help messages.

Example

// example.js

const {command, start} = require('sergeant')('example.js')
const assert = require('assert')

const say = (name, loud = false) => {
  let message = `hello ${name}.`

  if (loud) {
    message = `${message.toUpperCase()}!`
  }

  console.log(message)
}

const load = {
  loud: {
    description: 'say it loud',
  },
  l: 'loud'
}

command({
  name: 'hello',
  description: 'say hello',
  options: {
    ...loud,
    name: {
      description: 'the name',
      required: true
    },
  },
  action(args) {
    assert.notEqual(args.name, 'world', 'use hello world')

    say(args.name, args.loud)
  }
})

command({
  name: 'hello:world',
  description: 'say hello world',
  options: {
    ...loud
  },
  action(args) {
    say('world', args.loud)
  }
})

start(process.argv.slice(2))

@infinitebrahmanuniverse/nolb-serg @everything-registry/sub-chunk-2735 @erickmerchant/copy-files @erickmerchant/favicon @erickmerchant/framework-cli @erickmerchant/html @erickmerchant/optimize @erickmerchant/serve-files @erickmerchant/tasks @erickmerchant/assets @erickmerchant/checkup @erickmerchant/content ghost-hunter atlatl

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago