Skip to content

Personal CLI I use to start up projects with my particular settings.

Notifications You must be signed in to change notification settings

ZachCodedThat/create-zp-cli-public

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Links:


Why?

It was a fun way to learn deeper concepts around Node.

Currently this is just a barebones CLI that gives you the choice of 4 templates

Eventually

I want to build this out to provide theme tooling choices like Chakra-UI and Tailwind but as of right now the templates come with barebones CSS styling.


Built using


Usage

Run npx create-zp-cli to start your good time.

Note: If no flags are passed you will be prompted for a template choice and whether you want to install the deeps within the project along with the name of your project.

Project Name cli question Template cli question Install deeps cli question

Once completed let the magic happen and you are off to the races!


Flags

--yes , -y Skips all prompts and passes default vlaues for all options, defaults to false


--install , -i Installs all chosen template dependencies, defaults to false


[template] Specifies what template you want to use. spelling matters capitalization does not defaults to NextJS

Template choices: NextJS || NextJS-Typescript || React || React-Typescript


Dependencies

"arg": "^5.0.1", - Handles the initial flags that can be passed to the cli. src/cli.js

"chalk": "^4.1.2", - Handles fancy command line styling. src/main.js

"degit": "^2.8.4", - Handles how to clone a clean repo from GH src/main.js

"esm": "^3.2.18", - Used to allow for “import” statements to be used in the node environment without having to worry about differing node versions bin/create-zp-cli.js

"inquirer": "^8.2.0", - Handles the questions asked for the options not provided to the cli via flags. src/cli.js

"listr": "^0.14.3", - Handles the tasks that need to be completed according to what options are passed in to the cli via flags and prompts src.main.js

"pkg-install": "^1.0.0" - Handles the installation of the dependencies in the new repo directory. src/main.js