How to use the help function from yargs

Find comprehensive JavaScript yargs.help code examples handpicked from public code repositorys.

command.js

72
73
74
75
76
77
78
79
80
  console.error("Non-existing or no command specified.");
  process.exit(1);
})
yargs.demandCommand(1)

yargs.help('h')
yargs.alias('h', 'help')
yargs.alias('v', 'version')
yargs.env(meta.name.replace(/-/g, '').toUpperCase())

13

30

4

bin.js

GitHub: dockerizeme/dockerizeme

65
66
67
68
69
70
71
72
73
74
        });

    }
);
yargs.wrap(yargs.terminalWidth());
yargs.help();
let argv = yargs.argv;

// If verbose, enable logging
if (argv.verbose) {

18

24

2

api.md?plain=1

GitHub: yargs/yargs

277
278
279
280
281
282
283
284
285
286
var argv = require('yargs/yargs')(process.argv.slice(2))
  .fail(function (msg, err, yargs) {
    if (err) throw err // preserve stack
    console.error('You broke it!')
    console.error(msg)
    console.error('You should be doing', yargs.help())
    process.exit(1)
  })
  .argv
```

0

78

+ 5 other calls in file

CONTRIBUTING.md?plain=1

GitHub: alexwelcing/nodejs-docs-samples

173
174
175
176
177
178
179
180
181
182

var program = module.exports = {
  <METHOD_NAME>: <METHOD_NAME>,
  main: function (args) {
    // Run the command-line program
    cli.help().strict().parse(args).argv; // eslint-disable-line
  }
};

cli

0

2

+ 7 other calls in file

cli-flags.ts

GitHub: IncredibleWeb/lighthouse

15
16
17
18
19
20
21
22
23
24
      outputPath: string, interactive: boolean, saveArtifacts: boolean, saveAssets: boolean,
      view: boolean, maxWaitForLoad: number
}

export function getFlags() {
  return yargs.help('help')
      .version(() => pkg.version)
      .showHelpOnFail(false, 'Specify --help for available options')

      .usage('lighthouse <url>')

0

4

+ 3 other calls in file

Other functions in yargs

Sorted by popularity

yargs.argv is the most popular function in yargs (1012 examples)

Other popular packages:

Home

About

Privacy Policy