Socket
Socket
Sign inDemoInstall

clarg

Package Overview
Dependencies
0
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

clarg

Simple command line argument parser


Version published
Weekly downloads
985
decreased by-3.15%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

clarg

NPM Version NPM Downloads Travis build Coveralls coverage

The simplest command-line parsing utility for node.js

Why create another library for this?

All of the existing libraries (i.e. commander or nomnom) require you to specify upfront what options you expect.

Clarg simply returns you a full set of arguments it found allowing you to bind everything in any way you want, anywhere you want.

No questions asked, no prescribed way of doing things. Just a simple object.

Usage

Simply import clarg anywhere in your code and it will output an object.

You don't have to specify any options upfront, just require this module and execute it.

It doesn't matter where in code you run it - you will always get the same result which is really just a broken down list of arguments and options passed to the process.

It supports options specified with single dashes, double dashes and their values after a space or an equal sign.

The only thing that matters is the order: first you specify arguments, after the first dash has been spotted everything gets treated as an option.

Example

Running the script below with these arguments node test.js start countdown --format=long -detach -parse=yes will produce an object like this:

{
  args: [ 'start', 'countdown' ],
  opts: { format: 'long', detach: true, parse: 'yes' },
  raw: [ 'start', 'countdown', '--format=long', '-detach', '-parse=yes' ]
}

FAQs

Last updated on 11 May 2017

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc