https://github.com/kt3k/minimisted

Handy wrapper of `minimist`
https://github.com/kt3k/minimisted

cli commandline minimist

Last synced: about 1 month ago
JSON representation

Handy wrapper of `minimist`

• Host: GitHub
• URL: https://github.com/kt3k/minimisted
• Owner: kt3k
• Created: 2016-08-11T02:58:27.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-28T12:48:45.000Z (over 1 year ago)
• Last Synced: 2025-05-05T21:16:05.530Z (about 1 month ago)
• Topics: cli, commandline, minimist
• Language: JavaScript
• Size: 109 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# minimisted v2.0.1

![CI](https://github.com/kt3k/minimisted/workflows/CI/badge.svg)

[![codecov](https://codecov.io/gh/kt3k/minimisted/branch/master/graph/badge.svg)](https://codecov.io/gh/kt3k/minimisted)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

> A handy wrapper of `minimist`

# Install

    npm install minimisted

# Usage

You can write your cli like the following:

```js

// Your cli's entry point

const main = (argv) => {

}

require('minimisted')(main)

```

where `argv` is the command line options parsed by `minimist` i.e. `minimist(process.argv.slice(2))`.

Using object destructuring syntax, you can write it like the following:

```js

/**

 * @param {boolean} help Shows help message if true

 * @param {boolean} version Shows the version if true

 * ...

 * @param {string[]} _ The parameters

 */

const main = ({ help, version, _ }) => {

}

require('minimisted')(main)

```

# API

```js

const minimisted = require('minimisted')

```

## minimisted(main[, opts[, argv]])

- @param {Function} main The main function

- @param {Object} opts The option which is passed to minimist's 2rd arguments

- @param {string} argv The command line arguments. Default is `process.argv.slice(2)`.

This calls `main` with command line options parsed by the minimist with the given options.

# License

MIT