@rsgarate/grut-cli v0.1.0

Grut CLI

Generate ruts with format - cross platform

Badges

Installation

Install package:

# npm
npm install @rsgarate/grut-cli

# yarn
yarn install @rsgarate/grut-cli

# pnpm
pnpm install @rsgarate/grut-cli

Usage

$ rut --help

  Commands

    validate, v      Check if a rut is valid
    get-digit, gd    Get the check digit
    format, f        Format rut
    clean, c         Returns a rut without format
    generate        Returns a rut without format
    help  display help for command

Commands

Generate Rut

  Usage
    $ rut
      
    Options
        -f         Generate rut with format
        -s         Generate rut with single format, dash only

  Examples
        
    Generate rut without format
    $ rut

    Generate rut with format
    $ rut -f

    Generate rut with single format
    $ rut -s

Format Rut

  Usage
    $ rut format <rut>
      
    Options
        -s         Generate rut with single format, dash only

  Examples

    Generate rut with format
    $ rut format <rut>

    Generate rut with single format
    $ rut format -s <rut>

Validate Rut

  Usage
    $ rut validate <rut>

  Examples

    Validate rut
    $ rut validate <rut>

Clean Rut

  Usage
    $ rut clean <rut>

  Examples

    Clean rut
    $ rut clean <rut>

Get check digit

  Usage
    $ rut get-digit <rut>

  Examples

    Get check digit for
    $ rut get-digit <rut>

Related

Here are some related projects

• @rsgarate/rut - API for this module

Authors

• @ramsesgarate

License

Made with 💛

Published under MIT License.