# shargs-usage

> Automatic usage documentation generation for shargs

Latest version **1.0.2** (published 2021-01-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install shargs-usage
pnpm add shargs-usage
yarn add shargs-usage
bun add shargs-usage
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-01-31 |
| First published | 2020-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3.0 |
| Dependencies | 0 |
| Unpacked size | 43.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Philipp Wille |
| Maintainers | yordle |
| Keywords | shargs, command-line, parser |

## Links

- npm: https://www.npmjs.com/package/shargs-usage
- Repository: https://github.com/Yord/shargs-usage
- Issues: https://github.com/Yord/shargs/issues
- npm.io page: https://npm.io/package/shargs-usage

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-01-31
- 1.0.1 — 2021-01-17
- 1.0.0 — 2021-01-04
- 0.6.2 — 2021-01-04
- 0.6.0 — 2020-06-04
- 0.5.4 — 2020-04-30
- 0.5.3 — 2020-04-29
- 0.5.2 — 2020-04-28
- 0.5.1 — 2020-04-27
- 0.4.2 — 2020-04-26
- 0.4.1 — 2020-04-25
- 0.4.0 — 2020-04-25
- 0.3.5 — 2020-04-24
- 0.3.4 — 2020-04-20
- 0.3.3 — 2020-04-20
- … 6 more at https://npm.io/package/shargs-usage/versions

## README

shargs-usage is an automatic usage documentation generation library for [shargs][shargs] 🦈.

See the [`shargs` github repository][shargs] for more details!

[![node version][shield-node]][node]
[![npm version][shield-npm]][npm-package]
[![license][shield-license]][license]
[![PRs Welcome][shield-prs]][contribute]
[![linux unit tests status][shield-unit-tests-linux]][actions]
[![macos unit tests status][shield-unit-tests-macos]][actions]
[![windows unit tests status][shield-unit-tests-windows]][actions]

## Installation

```bash
$ npm install --save shargs-usage
```

## Documentation

`shargs-usage` is documented in the [automatic usage documentation generation section][documentation] of the [`shargs`][shargs] repository.

## Reporting Issues

Please report issues [in the `shargs` tracker][issues]!

## License

`shargs-usage` is [MIT licensed][license].



[actions]: https://github.com/Yord/shargs-usage/actions
[contribute]: https://github.com/Yord/shargs#contributing
[documentation]: https://github.com/Yord/shargs#automatic-usage-documentation-generation
[issues]: https://github.com/Yord/shargs/issues
[license]: https://github.com/Yord/shargs-usage/blob/master/LICENSE
[node]: https://nodejs.org/
[npm-package]: https://www.npmjs.com/package/shargs-usage
[shargs]: https://github.com/Yord/shargs
[shield-license]: https://img.shields.io/npm/l/shargs-usage?color=yellow&labelColor=313A42
[shield-node]: https://img.shields.io/node/v/shargs-usage?color=red&labelColor=313A42
[shield-npm]: https://img.shields.io/npm/v/shargs-usage.svg?color=orange&labelColor=313A42
[shield-prs]: https://img.shields.io/badge/PRs-welcome-green.svg?labelColor=313A42
[shield-unit-tests-linux]: https://github.com/Yord/shargs-usage/workflows/linux/badge.svg?branch=master
[shield-unit-tests-macos]: https://github.com/Yord/shargs-usage/workflows/macos/badge.svg?branch=master
[shield-unit-tests-windows]: https://github.com/Yord/shargs-usage/workflows/windows/badge.svg?branch=master

---
_Source: https://npm.io/package/shargs-usage · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._