Skip to content

stagas/typescript-cli-template

Repository files navigation

typescript-cli-template

typescript cli app template


Install

$ npm i my-cli-app -g

CLI

Usage: my-cli-app [options] <file> [<file>, ...] -- [...rest]

       <file> [<file>, ...]  Files to process
               -- [...rest]  The rest of the arguments

   -f, --flag                Flag about something
   -c, --count=n             How many times
   -C=...                    Choose color [blue,red,yellow]
   -s, --string=...          Some string
       --meh=...             Meh

API

Table of Contents

run

src/index.ts:43-46

Runs the cli app.

Parameters

  • options Options

    • options.file Files to process
    • options.rest The rest of the arguments
    • options.flag Flag about something
    • options.count How many times
    • options.color Color to use
    • options.string Some string
    • options.meh Some array of strings

Contribute

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2021 stagas