0.1.9 • Published 4 years ago

create-custom-cli-generator v0.1.9

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

CLI Project Generator

This project will allow developers to easily and quickly create CLIs that give them the most basic functionality in just a few seconds, and publish their projects to npm for users to install and start using right away.

To create and publish your own CLI:

  1. Install create-custom-cli globally
npm i -g create-custom-cli
  1. Create a new cli following the commmand prompts by running the create-custom-cli command
create-custom-cli
In the above step, we will create a name and a command for our cli. The name will be the folder created for our project, and the command will be what the application is registered as in the npm registry, which will be the name field in our newly created package.json.
We will reference these two items as <YourProjectName> and <your-project-command> in the following steps.
  1. CD into newly created project directory
cd <YourProjectName>
  1. Publish to npm (or link to test locally)
npm publish OR npm link
  1. Install new cli globally on your own machine (skip this step if you ran npm link)
npm i -g <your-project-command>
  1. Create new application using your new CLI
<your-project-command> MyAppName