Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
cli-argv-util
Advanced tools
Readme
<img src=https://centerkey.com/graphics/center-key-logo.svg align=right width=200 alt=logo>
Simple utility to parse command line parameters and flags (arguments vector)
cli-argv-util is called from your bin/cli.js
file in order to read user
supplied information on the command line and return the flags and parameters
in an easy-to-use structure.
Install package for node:
$ npm install cli-argv-util
Place the following code in your bin/cli.js file
import { cliArgvUtil } from 'cli-argv-util';
const validFlags = ['cd', 'find', 'no-summary'];
const cli = cliArgvUtil.parse(validFlags);
if (cliArgvUtil.invalidFlag)
throw Error(cliArgvUtil.invalidFlagMsg);
For a real world example, see: cli.js
If your CLI tool is named my-program
and a user runs it like:
$ my-program file.html --cd=src --no-summary file.png
the resulting cli
object will be:
{
flagMap: {
cd: 'src',
noSummary: undefined,
},
flagOn: {
cd: true,
find: false,
noSummary: true,
},
invalidFlag: null,
invalidFlagMsg: null,
params: ['file.html', 'file.png'],
}
The cliArgvUtil.parse()
returns an object of type Result
:
export type StringFlagMap = { [flag: string]: string | undefined };
export type BooleanFlagMap = { [flag: string]: boolean };
export type Result = {
flagMap: StringFlagMap, //map of flag values for each user supplied flag
flagOn: BooleanFlagMap, //map of the enabled status for all valid flags
invalidFlag: string | null, //name of the first invalid flag
invalidFlagMsg: string | null, //error message for the invalid flag
params: string[], //array of parameter values supplied by the user
};
See the TypeScript Declarations at the top of cli-argv-util.ts for documentation.
CLI Build Tools
Feel free to submit questions at:
github.com/center-key/cli-argv-util/issues
FAQs
Simple utility to parse command line parameters and flags (arguments vector)
We found that cli-argv-util demonstrated a healthy version release cadence and project activity because the last version was released less than 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
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).