https://github.com/bph/create-cli
Another exercise from NodeCLI.com course. I also use it for my personal automation projects and POCs.
https://github.com/bph/create-cli
Last synced: over 1 year ago
JSON representation
Another exercise from NodeCLI.com course. I also use it for my personal automation projects and POCs.
- Host: GitHub
- URL: https://github.com/bph/create-cli
- Owner: bph
- Created: 2020-12-29T15:00:43.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-30T21:16:46.000Z (almost 5 years ago)
- Last Synced: 2025-02-21T15:04:19.867Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# create-cli
This CLI for nodejs creates the scaffolding for a new node CLI package.
## Install
`npm install @paulisystems/create-cli`
## Usage ##
`npm ncli`
## Input:
* **name:** Give your new CLI a name in kebab-notation. This is also used as a directory name of the new CLI.
* **command:** command to initiate the CLI. Optional. If left blank the cli name is used as command, too.
* **description:** Enter a description for your new CLI.
* **version:** _default_ `0.0.1`
* **license:** _default_ `MIT`
* **authorName**, **authorEmail**, **authorURL** Author information with name, email and url. These will be stored in the /utils/.history folder for future scaffolding
Modify the files in the */template* folder for additional default settings. Use {{nvarname}} for replacement variables.
Use `ncli help` for commands and options.
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.
## History
This is an example project of the NodeJS CLI course by Ahmad Awais