1.0.1 • Published 1 year ago

flagts v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

:dart: Features

  • Easy to Use
  • Support for Booleans, Strings, and Numbers
  • Fully customizeable and automatically generated help messages
  • Support for hidden and required flags

:toolbox: Getting Started

:gear: Installation

Install FlagTS with npm

  npm install flagts

:eyes: Usage

import { Flags } from 'flagts';

Flags.addHelp("help", ["h", "aliases"], "Displays the help message")

let myString = Flags.addNum("name", "Default Value", ["alias1", "a"], "Here is the help message", { hidden: false, required: false });

Flags.parse()

console.log(myString)

/*

Command:
> node ./main.js --name "Some String (quotes are optional)"

Output:
> Some String (quotes are optional)

*/

Full Documentation

:wave: Contributing

Contributions are always welcome!

:warning: License

Distributed under the MIT License. See LICENSE.md for more information.

:gem: Acknowledgements