Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/herber/argi
A simple args parser
https://github.com/herber/argi
args argument-parser arguments argv parser
Last synced: 20 days ago
JSON representation
A simple args parser
- Host: GitHub
- URL: https://github.com/herber/argi
- Owner: herber
- License: mit
- Created: 2017-08-24T10:54:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-05T05:56:07.000Z (about 7 years ago)
- Last Synced: 2024-10-20T02:50:38.809Z (about 1 month ago)
- Topics: args, argument-parser, arguments, argv, parser
- Language: JavaScript
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# argi [](https://github.com/tobihrbr/fyi) [](https://travis-ci.org/herber/argi) [](https://ci.appveyor.com/project/tobihrbr/argi) [](https://coveralls.io/github/tobihrbr/argi?branch=master)
> A simple args parser
## Install
```
$ npm install --save argi
```
## Usage
```js
const argi = require('argi');
// Options
argi.option('name', 'description', { default: 'bob', aliases: 'n', boolean: false, hidden: false });
// Commands
argi.command('sayhi', 'description', { hidden: false });
// Parse argv
const parsed = argi.parse(process.argv.slice(2));
if (parsed.sayhi) {
console.log(`Hi ${ parsed.name }!`);
} else {
console.log(args.help());
}
```
## API
### argi.options(name, description[, options])
#### name
Type: `string`
The option's name.
#### description
Type: `string`
What the option does. Will be used for help.
#### options
Type: `object`
##### default
Type: `string`
The options default value.
##### aliases
Type: `string`, `array`
Alias names for the option.
##### boolean
Type: `boolean`
Default: `false`
Specifies whether the option is a boolean(`true`/`false`) or a string. If set to true arguments after the option will count as a command or as a separate option.
Example:
```js
...
argi.option('boolean', 'description', { boolean: true });
const parsed = argi.parse(['--boolean', 'value'])
parsed.boolean // => true
parsed._ // => ['value']
...
```
##### hidden
Type: `boolean`
Default: `false`
If option should be displayed in help.
### argi.command(name, description[, options])
#### name
Type: `string`
The command's name.
#### description
Type: `string`
What the command does. Will be used for help.
#### options
Type: `object`
##### hidden
Type: `boolean`
Default: `false`
If command should be displayed in help.
### argi.help()
Returns a help string. Will throw an error if it's called before argi.parse()
### argi.parse(argv)
#### argv
An array of cli options. You should probably set it to `process.argv.slice(2)`
Returns an object with the option's values and if commands should be executed.
Example:
```js
...
const parsed = argi.parse(['--test', '--opt', 'yes', 'build']);
// => {
// => test: true,
// => opt: 'yes',
// => build: true
// => }
...
```
## License
MIT © [Tobias Herber](https://tobihrbr.com)