https://github.com/stbestichhh/stlib-args-parser

CLI args parser for Node.js
https://github.com/stbestichhh/stlib-args-parser

args args-parser cli cli-parser util

Last synced: about 14 hours ago
JSON representation

CLI args parser for Node.js

• Host: GitHub
• URL: https://github.com/stbestichhh/stlib-args-parser
• Owner: stbestichhh
• License: mit
• Created: 2024-09-09T12:52:48.000Z (about 2 months ago)
• Default Branch: master
• Last Pushed: 2024-09-09T13:02:01.000Z (about 2 months ago)
• Last Synced: 2024-09-09T15:34:17.567Z (about 2 months ago)
• Topics: args, args-parser, cli, cli-parser, util
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@stlib/argv
• Size: 73.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Node.js CI](https://github.com/stbestichhh/stlib-args-parser/actions/workflows/node.js.yml/badge.svg)](https://github.com/stbestichhh/stlib-args-parser/actions/workflows/node.js.yml)

[![NPM Version](https://img.shields.io/npm/v/@stlib/argv)](https://www.npmjs.com/package/@stlib/argv)

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

# @stlib/argv

## Table of contents

* [Description](#about)

* [Getting started](#getting-started)

  * [Instalation](#installation)

  * [Usage](#usage)

* [Contributing](#contributing)

* [Changelog](#changelog)

* [Authors](#authors)

* [License](#license)

## Getting started

### Installation

```shell

$ yarn add @stlib/argv

```

> [!IMPORTANT]

> **Node.js 18.x+** version must be installed in your OS.

### Usage

Object type for arguments

```TypeScript

OptionsType {

  [key: string]: string;

}

```

```TypeScript

// Parses arhuments and return object

function parseArgs(argv: string[]): OptionsType;

// Object with parsed arguments

const options: OptionsType;

```

**Example**

```shell

$ yarn ts-node index.ts -a --b -c=1 --d= 2 --e=smth=3 -f 4

```

```TypeScript

import { options } from '@stlib/argv';

console.log(options);

// Output: { a: true, b: true, c: '1', d: '2', e: 'smth=3', f: '4' }

```

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Changelog

Project changes are writen in changelog, see the [CHANGELOG.md](CHANGELOG.md).

We use [SemVer](https://semver.org/) for versioning.

For the versions available, see the [tags](https://github.com/stbestichhh/stlib-args-parser/tags) on this repository.

For the versions supported, see the [SECURITY.md](SECURITY.md).

## Authors

- [@stbestichhh](https://www.github.com/stbestichhh)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE)