Using yargs (npm package), how to give an error if command not found?

Question

I have yargs with 2 commands?

yargs
.command('test-all','',handler)
.command('test-file','',handler)
.argv

The user inputs:

node myapp.js other-command

But yargs don't throw an error. What should I do?

score 3 · Accepted Answer · answered Sep 02 '20 at 05:29

3

You can use .demandCommand() to do this:

yargs
  .command('test-all','',handler)
  .command('test-file','',handler)
  .demandCommand(1, 'You need at least one command before moving on')
  .argv

answered Sep 02 '20 at 05:29

Richie Bendall

7,738
4
38
58

2

It is not answering. The user can give any command. I want to enforce him only to one of the commands I specified. – Aminadav Glickshtein Sep 03 '20 at 06:05
@AminadavGlickshtein In that case, instantiate the yargs value and conditionally run `.command()` – Richie Bendall Sep 03 '20 at 06:54

score 2 · Answer 2 · answered Mar 07 '22 at 13:41

2

You just need to define a command on everything else (* wilcard) that shows the help.

yargs
  .command('test-all','',handler)
  .command('test-file','',handler)
  .command('*','', () => { y.showHelp(); })
  .argv

answered Mar 07 '22 at 13:41

Eric Groise

21
1

score 0 · Answer 3 · answered Feb 15 '23 at 16:23

0

Best way to do this now is with:

.demandCommand().recommendCommands().strict()

This also solves the issue wherein you don't enter any command.

answered Feb 15 '23 at 16:23

Clarence Liu

3,874
2
25
29

What each parameter is doing? `demandCommand` `recommendCommands` and `strict` Do we need all? (You can edit the answer) – Aminadav Glickshtein Feb 16 '23 at 09:42

Using yargs (npm package), how to give an error if command not found?

3 Answers3