Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
commandpost
Advanced tools
commandpost is a command-line options parser. This library is inspired by commander.
commander is very user-friendly, but not TypeScript-friendly. commandpost aims to improve this. Of course, commandpost can also be used from an ordinary JavaScript program. :+1:
$ npm install --save commandpost
$ cat cli.ts
import * as commandpost from "commandpost";
let root = commandpost
.create<{ spice: string[]; }, { food: string; }>("dinner <food>")
.version("1.0.0", "-v, --version")
.description("today's dinner!")
.option("-s, --spice <name>", "What spice do you want? default: pepper")
.action((opts, args) => {
console.log(`Your dinner is ${args.food} with ${opts.spice[0] || "pepper"}!`);
});
commandpost
.exec(root, process.argv)
.catch(err => {
if (err instanceof Error) {
console.error(err.stack);
} else {
console.error(err);
}
process.exit(1);
});
$ node cli.js --help
Usage: dinner [options] [--] <food>
Options:
-s, --spice <name> What spice do you want? default: pepper
$ node cli.js -s "soy sause" "fillet steak"
Your dinner is fillet steak with soy sause!
A top-level command is created by the commandpost.create
function.
commandpost also supports sub-commands.
A sub-command is created by using the topLevelCommand.subCommand
method.
Refer to this example for a demonstration.
commandpost can automatically generate help and command usage messages based on your configuration. For best results, it is recommended that you should set .version
and .description
for your top-level command.
// shorthand & formal option with a required parameter. value is converted to string[].
cmd.option("-c, --config <configFile>", "Read setting from specified config file path");
// option with optional parameter. value is converted to string[].
cmd.option("-c, --config [configFile]", "Read setting from specified config file path");
// option without parameter (flag). option value is converted to boolean and defaults to `false`.
cmd.option("--suppress-warning", "Suppress warning");
// option with `--no-` prefix. option value is converted to boolean and defaults to true.
cmd.option("--no-type-checking", "Type checking disabled");
If you want to handle unknown options, you can use the .allowUnknownOption
method.
// required argument
commandpost.create<{}, { food: string; }>("dinner <food>");
// optional argument
commandpost.create<{}, { food: string; }>("dinner [food]");
// variadic argument
commandpost.create<{}, { foods: string[]; }>("dinner <food...>");
This package's author, vvakame, is not a native English speaker. My first language is Japanese. If you find incorrect English, please send me a pull request.
FAQs
commandline option parser
We found that commandpost demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.