Package description
The 'meow' npm package is a CLI helper that simplifies the process of writing command-line applications in Node.js. It parses arguments, generates help text, and handles errors.
Argument Parsing
Meow parses command-line arguments and options, making them easily accessible within your application.
const meow = require('meow');
const cli = meow(`
Usage
$ foo <input>
`);
console.log(cli.input); //=> ['inputValue']
console.log(cli.flags); //=> {flagName: flagValue}Help Text Generation
Meow automatically generates and displays help text for your CLI application based on a template you provide.
const meow = require('meow');
const cli = meow(`
Usage
$ foo <input>
Options
--rainbow, -r Include a rainbow
`);
// If the user runs the command with `--help`, meow will automatically display the help text.Flags Customization
Meow allows you to define and customize flags for your CLI application, including setting aliases and default values.
const meow = require('meow');
const cli = meow(`
Usage
$ foo <input>
`, {
flags: {
rainbow: {
type: 'boolean',
alias: 'r'
}
}
});
console.log(cli.flags.rainbow); //=> true or falseYargs is a powerful npm package that helps you build interactive command-line tools, by parsing arguments and generating an elegant user interface. It's more feature-rich than meow, providing a wide range of options for argument parsing, command handling, and validation.
Commander is another npm package for writing command-line applications. It's similar to meow but offers a more object-oriented approach to defining commands and options. Commander is well-suited for complex CLI applications with sub-commands.
Minimist is a minimalistic argument parsing library. Unlike meow, it focuses solely on parsing command-line arguments without any additional features like help text generation or input validation.
Readme
CLI app helper
--version--help$ npm install --save meow
$ ./foo-app.js unicorns --rainbow-cake
#!/usr/bin/env node
'use strict';
var meow = require('meow');
var fooApp = require('./');
var cli = meow({
help: [
'Usage',
' foo-app <input>'
].join('\n')
});
/*
{
input: ['unicorns'],
flags: {rainbowCake: true},
...
}
*/
fooApp(cli.input[0], cli.flags);
Returns an object with:
input (array) - Non-flag argumentsflags (object) - Flags converted to camelCasepkg (object) - The package.json objecthelp (object) - The help text used with --helpshowHelp() (function) - Show the help text and exitType: string, boolean
The help text you want shown.
If you don't specify anything, it will still show the package.json "description".
Set it to false to disable it all together.
Type: string, boolean
Default: the package.json "version" property
Set a custom version output.
Set it to false to disable it all together.
Type: string, object
Default: package.json
Relative path to package.json or it as an object.
Type: array
Default: process.argv.slice(2)
Custom arguments object.
Type: object
Default: {}
Minimist options.
MIT © Sindre Sorhus
FAQs
CLI app helper
We found that meow 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
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.