Facing this error: TypeError: yargs.command is not a function

Question

I am trying to run the yargs.command command. I tried running this code snippet :

import yargs from "yargs";
yargs.command({
  command: "list",
  describe: "List all commands",
  handler: function () {
    console.log("Listing all commands.");
  },
});

yargs.command({
  command: "read",
  describe: "Reading all commands",
  handler: function () {
    console.log("Reading all commands");
  },
});

And I got this error in the output:

TypeError: yargs.command is not a function
    at file:///media/Main-Volume/courses/Udemy%20courses/Node%20JS%20bootcamp/notes-app/app.js:23:7
    at ModuleJob.run (internal/modules/esm/module_job.js:145:37)
    at async Loader.import (internal/modules/esm/loader.js:182:24)
    at async Object.loadESM (internal/process/esm_loader.js:68:5)

After searching on the internet, I came across this solution and added this statement in my code at the end: yargs.parse(). But unfortunately, I am still getting the same output.

My OS: MX-Linux 21.

Node: 12.22.5.

yargs: 17.4.1.

vs code: 1.66.2.

Does anyone have any clue what went wrong? Any help would be appreciated.

This will help you Click here.

Jamshy EK
– Jamshy EK

2025-02-13 09:42:49 +00:00
Commented Feb 13 at 9:42 — Jamshy EK
– Jamshy EK, Commented Feb 13 at 9:42

0xLogN · Accepted Answer · 2022-04-14 03:58:46Z

9

yargs is a function which returns the object with the .command property you want. From the README:

yargs(hideBin(process.argv))
  .command('curl <url>', 'fetch the contents of the URL', () => {}, (argv) => {
    console.info(argv)
  })
  .demandCommand(1)
  .parse()

Your code should look something like this:

import yargs from "yargs";
import {hideBin} from "yargs/helpers";

yargs(hideBin(process.argv))
    .command('list', 'List all commands', /*handler*/)
    .command(/*...*/)
    .parse();

edited Apr 14, 2022 at 3:58

answered Apr 14, 2022 at 3:48

0xLogN

3,8831 gold badge20 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

belmont Over a year ago

So what should the code look like? I am not getting at all what you are trying to say. My apologies for that.

0xLogN Over a year ago

@lonewolf Is that more clear? Also help is the more common name, not 'list'

belmont Over a year ago

it is solved. Thanks. I was doing that as part of an exercise in an online course. I was asked to include 'list' instead of 'help.'

Tyler2P · Accepted Answer · 2022-12-18 11:16:37Z

-3

This is wrong:

yargs.command({
  command:
})

The below is right:

yargs({
  command:
})

edited Dec 18, 2022 at 11:16

Tyler2P

2,37030 gold badges26 silver badges34 bronze badges

answered Dec 14, 2022 at 16:06

obadia4ever

112 bronze badges

Collectives™ on Stack Overflow

Facing this error: TypeError: yargs.command is not a function

2 Answers 2

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related