https://github.com/stagas/typescript-cli-template
typescript cli app template
https://github.com/stagas/typescript-cli-template
cjs cli esm template typescript
Last synced: about 1 year ago
JSON representation
typescript cli app template
- Host: GitHub
- URL: https://github.com/stagas/typescript-cli-template
- Owner: stagas
- Created: 2021-12-13T05:45:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-13T06:56:41.000Z (over 4 years ago)
- Last Synced: 2025-02-11T08:48:12.278Z (over 1 year ago)
- Topics: cjs, cli, esm, template, typescript
- Language: TypeScript
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
typescript-cli-template
typescript cli app template
***
## Install
```sh
$ npm i my-cli-app -g
```
## CLI
Usage: my-cli-app [options] [, ...] -- [...rest]
[, ...] 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](#run)
* [Parameters](#parameters)
### run
[src/index.ts:43-46](https://github.com/stagas/typescript-cli-template/blob/ee315409256990cd10df682d8736dec4bad04cbc/src/index.ts#L43-L46 "Source code on GitHub")
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](https://github.com/stagas/typescript-cli-template/fork) or
[edit](https://github.dev/stagas/typescript-cli-template) and submit a PR.
All contributions are welcome!
## License
MIT © 2021
[stagas](https://github.com/stagas)