https://github.com/jesusgraterol/argv-utils

The argv-utils package is a lightweight library for Node.js that simplifies working with command-line arguments passed to your scripts. It streamlines the process of accessing and managing arguments from process.argv property.
https://github.com/jesusgraterol/argv-utils

args arguments argv argvs node parser sh shell shell-script utilities utils

Last synced: 22 days ago
JSON representation

The argv-utils package is a lightweight library for Node.js that simplifies working with command-line arguments passed to your scripts. It streamlines the process of accessing and managing arguments from process.argv property.

• Host: GitHub
• URL: https://github.com/jesusgraterol/argv-utils
• Owner: jesusgraterol
• License: mit
• Created: 2024-05-04T13:42:56.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-06T15:23:52.000Z (6 months ago)
• Last Synced: 2024-10-13T02:06:01.584Z (about 1 month ago)
• Topics: args, arguments, argv, argvs, node, parser, sh, shell, shell-script, utilities, utils
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/argv-utils
• Size: 134 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# argv Utils

The `argv-utils` package is a lightweight library for Node.js that simplifies working with command-line arguments passed to your scripts. It streamlines the process of accessing and managing arguments from `process.argv` property.

## Getting Started

Install the package:

```bash

$ npm install -D argv-utils

```

Manage your arguments with ease:

```typescript

$ node my-script.js --one --two="Hello World!" --someValue="false"

// my-script.js

import { argv } from 'node:process';

import { parseArgs } from 'argv-utils';

parseArgs(argv);

// {

//    execPath: '/usr/local/bin/node',

//    scriptPath: '/path/to/my-script.js',

//    one: 'true',

//    two: 'Hello World!',

//    someValue: 'false',

// }

```




## Built With

- JavaScript / TypeScript




## Running the Tests

```bash

$ npm run test:unit

```




## License

[MIT](https://choosealicense.com/licenses/mit/)




## Acknowledgments

- ...




## @TODOS

- [ ] ...




## Deployment

Install dependencies:

```bash

$ npm install

```

Build the library:

```bash

$ npm start

```

Publish to `npm`:

```bash

$ npm publish

```