commander.js : how to specify required cli argument

Question

I'm using commander.js package for parsing command-line arguments: I'd like to make a flag non-optional, the API and tests in the git repo loosely mention making a flag required, but I usually need to be hit over the head with instructions.

Is it actually possible, and will the script throw if the requirement is not met?

score 22 · Accepted Answer · answered Jun 12 '14 at 04:42

22

I guess this is not supported by commander.js https://github.com/visionmedia/commander.js/issues/44

But you can do something like this in your program -

if (!program.myoption) 
  throw new Error('--myoption required')

answered Jun 12 '14 at 04:42

vinayr

11,026
3
46
42

4

commander has `program.requiredOption()` to flag an option as required now. – jiminssy Jun 28 '21 at 10:05

score 6 · Answer 2 · answered Jan 20 '22 at 17:18

It depends on how you write the arguments.

With <> it is required.
With [] it is not required.

See exemple.

const commander = require('commander')
    , program = new commander.Command()

program
   .command('autorecord')
   .argument('<title>', 'Title and file name of record') // is required
   .argument('[type]', 'Type of record. "undefined" by default') // is not required

commander.js : how to specify required cli argument

2 Answers2