Commander.js Commander.js este soluția completă pentru construirea interfețelor în linie de comandă (CLI) în Node.js.
Configurare de bază CLI
const { program } = require('commander');
program
.name('my-cli')
.description('Sample CLI utility written in Node.js')
.version('1.0.0');
Parsarea opțiunilor și flag-urilor
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>: Valoare obligatorie a argumentului.[value]: Valoare opțională a argumentului.- Flag-urile fără parametri funcționează ca comutatoare booleene.
Subcomenzi
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();
Personalizarea ecranului de ajutor
// Adăugare text de subsol personalizat la ieșirea comenzii --help
program.addHelpText('after', `
Example call:
$ my-cli -c ./app.json --port 8080
`);
// Afișare manuală a mesajului de ajutor
program.outputHelp();