<commit_before>[![Build Status](https://travis-ci.org/clinuz/blargs.svg?branch=master)](https://travis-ci.org/clinuz/blargs)
# blargs
_(think the expression "BLARG" munged with "args")_

Check the [changelog](CHANGES.md) for notes on what has been done between releases.

### Versatile argument parser with command-line test utility


While it is not my general goal to re-create something that has been exhaustively developed and engineered, I often find myself needing features that are not consistently available from a single source. _blargs_ is an attempt to create a simple, reliable, performant and consistent argument parser that can be used as-is or wrapped by other utilities.

While this project is _vastly_ different in implementation, I would like to give a shout-out to some projects I have used over the years that influenced some of the features I have added:

- [minimist](https://github.com/substack/minimist) by @substack
- [subarg](https://github.com/substack/subarg) by @substack
- [nomnom](https://github.com/harthur/nomnom) (deprecated) by @harthur

### Check This

```bash
# can also be used in your project
npm install -g blargs
# test using the command-line test utility
blargs "is this" -a --test
# => [ { a: true, test: true }, [ 'is this' ], null ]
echo '"is this" -a --test' | blargs
# => [ { a: true, test: true }, [ 'is this' ], null ]
```

Wondering what that output means and how the hell it's useful? [Read about programmatic usage and see the examples](#programmatic-usage).

### Quick Contents<commit_msg>make sure the link is working for changelog<commit_after>[![Build Status](https://travis-ci.org/clinuz/blargs.svg?branch=master)](https://travis-ci.org/clinuz/blargs)
# blargs
_(think the expression "BLARG" munged with "args")_

Check the [changelog](https://github.com/clinuz/blargs/blob/master/CHANGELOG.md) for notes on what has been done between releases.

### Versatile argument parser with command-line test utility


While it is not my general goal to re-create something that has been exhaustively developed and engineered, I often find myself needing features that are not consistently available from a single source. _blargs_ is an attempt to create a simple, reliable, performant and consistent argument parser that can be used as-is or wrapped by other utilities.

While this project is _vastly_ different in implementation, I would like to give a shout-out to some projects I have used over the years that influenced some of the features I have added:

- [minimist](https://github.com/substack/minimist) by @substack
- [subarg](https://github.com/substack/subarg) by @substack
- [nomnom](https://github.com/harthur/nomnom) (deprecated) by @harthur

### Check This

```bash
# can also be used in your project
npm install -g blargs
# test using the command-line test utility
blargs "is this" -a --test
# => [ { a: true, test: true }, [ 'is this' ], null ]
echo '"is this" -a --test' | blargs
# => [ { a: true, test: true }, [ 'is this' ], null ]
```

Wondering what that output means and how the hell it's useful? [Read about programmatic usage and see the examples](#programmatic-usage).

### Quick Contents
{'fraction_non_alphanumeric': 0.10661183169882948, 'fraction_numerical': 0.0, 'mean_word_length': 4.508710801393728, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 11, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1609818', 'n_tokens_mistral': 930, 'n_tokens_neox': 898, 'n_words': 394}