clp
!Support me on Patreonbadgepatreonpatreon !Buy me a bookbadgeamazonamazon !PayPalbadgepaypaldonatepaypal-donations A tiny and fast command line arguments parser.
:rocket: Migration from 3.x.x
to 4.x.x
As of 4.0.0
the scope of this package will be to simply parsearguments. Use
tilda
for a high-level interface for building cli tools.
:cloud: Installation
# Using npm
npm install --save clp
# Using yarn
yarn add clp
:clipboard: Example
#!/usr/bin/env node
const clp = require("clp");
console.log(clp(["grep", "-ri", "foo"]));
// { _: [ 'grep' ], r: true, i: 'foo' }
console.log(clp(["--name", "Johnny", "-a", "20", "--location", "Earth", "--no-student"]));
// { _: [], name: 'Johnny', a: 20, location: 'Earth', student: false }
:question: Get Help
There are few ways to get help:1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: 3. For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
clp(args)
Parses the cli arguments.Params
- Array
args
: The arguments to parse (default: the process arguments).
Return
- Object An object containing the parsed arguments.
:yum: How to contribute
Have an idea? Found a bug? See how to contributecontributing.:sparklingheart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket: - !Buy me a bookbadgeamazonamazon—I love books! I will remember you after years if you buy me one. :grin: :book: - !PayPalbadgepaypalpaypal-donations—You can make one-time donations via PayPal. I'll probably buy a
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
![](https://i.imgur.com/z6OQI95.png)
Thanks! :heart::cake: Thanks
This package is heavily based onminimist
. :sparkles::dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:-
tilda
- diable
- a-csv
- engine-tools
- ghcal
- name-it
- namy
- no-one-left-behind
- wrabbit
- arc-asm
- gh-notifier
- emojer-cli
- github-emojify
- github-labeller
- image-to-ascii-cli
- git-stats-importer
- github-stats
- kindly-license
- npmreserve
- namly
- tithe
- ssh-remote
- rucksack.js
- tinyreq-cli
- cdnjs-importer
- electron-comrade
- @isysd/gpm
- ssb-chat
- gpm
- photon-browser
- 3abn
- birthday
- git-issues