args-flagify
v2.3.0
Published
Node.js CLI helper with zero dependencies
Downloads
71
Maintainers
Readme
args-flagify
Node.js CLI helper with zero dependencies
Inspired by Sindre Sorhus and his beautiful CLI helper meow.
Install
$ npm install --save args-flagify
Usage
$ your-cli firstInput --radius 2.45
#!/usr/bin/env node
const argsFlagify = require('args-flagify');
const cli = argsFlagify(
`
Usage
$ your-cli <input>
Options
--radius, -r Enter your radius
Examples
$ your-cli firstInput --radius 2.45
$ your-cli firstInput -r 2.45
`, {
radius: {
type: 'number',
alias: 'r',
default: 5,
},
});
console.log(cli);
/* output
{
inputs: ['firstInput'],
flags: {
radius: 2.45
},
help: '\n' +
' Usage\n' +
' $ your-cli <input>\n' +
'\n' +
' Options\n' +
' --radius, -r Enter your radius\n' +
'\n' +
' Examples\n' +
' $ your-cli firstInput --radius 2.45\n' +
' $ your-cli firstInput -r 2.45',
version: 1.0.1
}
*/
$ your-cli --help
Usage
$ your-cli <input>
Options
--radius, -r Enter your radius
Examples
$ your-cli firstInput --radius 2.45
$ your-cli firstInput -r 2.45
$ your-cli --version
$ your-cli -v
1.0.3
API
argsFlagify(help, flags?)
Returns an object with:
inputs
(Array) - Non flag argumentsflags
(Object) - flags (the key is the flag name, the value is the flag value of type:string
,number
orboolean
)help
(string) - the help text used with--help
version
(string) - the version of your CLI
help
Type: string
The help text for your CLI.
flags
Type: Object
The flags to parse.
The key is the flag name.
The value is the flag type: number, string, boolean
, or an object with the flag options:
type
: Type of the value. (Possible values:string
,boolean
,number
)alias
: Short flag alias.default
: Default value if the flag is not provided. Type:number, string, boolean
.
Example:
argsFlagify(`
...
help text
...
`, {
radius: 'number',
firstName: {
type: 'string',
alias: 'fn'
},
print: {
type: 'boolean',
default: true,
},
});
LICENSE
MIT