Référence rapide

Antisèche de la bibliothèque CLI Commander.js

Guide de référence rapide pour Commander.js dans Node.js : options, sous-commandes, analyse des arguments et personnalisation de l'aide.

· Publié le

Commander.js Commander.js est la solution complète pour concevoir des interfaces en ligne de commande (CLI) avec Node.js.

Configuration de base de la CLI

const { program } = require('commander');

program
  .name('my-cli')
  .description('Sample CLI utility written in Node.js')
  .version('1.0.0');

Analyse des options et flags

program
  .option('-p, --port <number>', 'specify port number', 3000)
  .option('-s, --silent', 'suppress terminal output')
  .option('-e, --env <mode>', 'execution environment', 'development')
  .requiredOption('-c, --config <path>', 'path to configuration file');

program.parse(process.argv);

const options = program.opts();
console.log(options.port, options.silent, options.config);
  • <value>: Valeur d'argument requise.
  • [value]: Valeur d'argument facultative.
  • Les flags sans paramètres agissent comme des booléens.

Sous-commandes

program
  .command('clone <source> [destination]')
  .description('clone a repository into a directory')
  .option('-b, --branch <name>', 'clone a specific branch')
  .action((source, destination, cmdOptions) => {
    console.log(`Cloning ${source} into ${destination || '.'}`);
  });

program.parse();

Personnalisation de l'aide

// Ajouter un pied de page personnalisé à la sortie de --help
program.addHelpText('after', `
Example call:
  $ my-cli -c ./app.json --port 8080
`);

// Afficher manuellement le message d'aide
program.outputHelp();

Sujets associés