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

Deno

import pkg from 'https://unpkg.com/get-cli-arg@^8.6.0/edition-deno/index.ts'

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-es2022/index.js
• get-cli-arg/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• get-cli-arg/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
• get-cli-arg/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• get-cli-arg/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

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

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

• Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

• Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

• Benjamin Lupton — view contributions

Finances

Sponsors

• Andrew Nesbitt — Software engineer and researcher
• Balsa — We're Balsa, and we're building tools for builders.
• Codecov — Empower developers with tools to improve code quality and testing.
• Poonacha Medappa
• Rob Morris
• Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
• Syntax — Syntax Podcast

Donors

• Andrew Nesbitt
• Armen Mkrtchian
• Balsa
• Chad
• Codecov
• dr.dimitru
• Elliott Ditman
• entroniq
• GitHub
• Hunter Beast
• Jean-Luc Geering
• Michael Duane Mooring
• Michael Harry Scepaniak
• Mohammed Shah
• Mr. Henry
• Nermal
• Pleo
• Poonacha Medappa
• Rob Morris
• Robert de Forest
• Sentry
• ServieJS
• Skunk Team
• Syntax
• WriterJohnBuck

License

Unless stated otherwise all works are:

• Copyright © Benjamin Lupton

and licensed under:

• Artistic License 2.0