https://github.com/mhio/node-largs
largs - light argument parsing for node cli apps
https://github.com/mhio/node-largs
Last synced: 2 months ago
JSON representation
largs - light argument parsing for node cli apps
- Host: GitHub
- URL: https://github.com/mhio/node-largs
- Owner: mhio
- License: mit
- Created: 2019-09-24T01:46:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T23:35:55.000Z (about 2 years ago)
- Last Synced: 2025-03-02T01:28:11.474Z (3 months ago)
- Language: JavaScript
- Size: 314 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# [largs](https://github.com/mhio/node-largs)
## Light weight arguments, command line parser
Simple cli arguments configuration and parsing with minimal dependencies.
The API has a similar feel to [Yargs](http://yargs.js.org/) but largs has a limited feature set.
Requires Node 10+
## Install
npm install largs --save
yarn add largs
## Usage
Create an `.option` - `./script --option value -s short`
or `.positional` - `./script one two`
or a sub `.command` that supports all the same largs setup - `./command run --option value`
and then `.run()` to process and return the options in a simple object
### Options
Shortcut Options config setup
```javascript
//import Largs from 'largs'
const { Largs } = require('largs')
const args = Largs.run({
first: { short: 'f', required: true },
second: { short: 's', long: 'two', type: 'integer', default: 1 },
command_bork: {
onlyhere: { type: String },
}
})
console.log(args.bork.onlyhere) // => 'chef'
```
For functional setup
```javascript
//import largs from 'largs'
const { largs } = require('largs')
largs.option('firstthing')
.short('f')
.required()
largs.option('otherthing')
.short('s')
.long('two')
.type('integer')
.default(1)
largs.command('bork')
.option('onlyforbork')
.type('string)
largs.positional('one')
.type('enum', ['this'])
.required()
const args = largs.run() // returns object representation of opts. `opts.largs`
console.log(args) // => { firstthing: "val", otherthing: "val", bork: { onlyforbork: 'yep' }, positional: [ 'one' ] }
```
```
→ node app.js --two 22222 this
Error: Missing required arguments
"--firstthing/-f" is required
→ node app.js -f one --two 22222
Error: 1 argument is required
→ node app.js -f one --two 22222 asdf
Error: Arg "1" was "asdf" but must be one of: this"
→ node app.js -f one --two 22222 this
{ options: { first: 'one', second: 22222 },
positional: [ 'this' ],
config:
{ firstthing:
{ name: 'firstthing',
short: 'f',
long: 'firstthing',
description: undefined,
help: undefined,
group: '' },
otherthing:
{ name: 'otherthing',
short: 's',
long: 'two',
description: undefined,
help: undefined,
group: '' } } }
```
## API
## About
largs is released under the MIT license.
Copyright 2019-2021 mhio
https://github.com/mhio/node-largs