get-cli-arg

Get the value of a CLI argument

Usage

Complete API Documentation.

Supports fetching the value of an argument with the following convention:

• --arg => true
• --arg= => false
• --arg="string" => "string"
• --arg={"a":1} => {"a": 1}

Uses normalify for value parsing.

import getarg from 'get-cli-arg'
console.log(getarg('arg'))
console.log(getarg('arg', process.argv))

Install

npm

• Install: npm install --save get-cli-arg
• Import: import pkg from ('get-cli-arg')
• Require: const pkg = require('get-cli-arg').default

Editions

This package is published with the following editions:

• get-cli-arg/source/index.ts is TypeScript source code with Import for modules
• get-cli-arg aliases get-cli-arg/edition-esnext/index.js
• get-cli-arg/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js with Require for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton
• Benjamin Lupton — view contributions
• dependabot-preview[bot] — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2019+ Benjamin Lupton

and licensed under:

• MIT License