:sparkles: Features

• :boat: yargs

• :crayon: chalk - Colorize output

• :sushi: rollup - Bundler

• :arrow_up: np - A better npm publish

• :straight_ruler: ava - Super simple test framework

• :policeman: xo and tsc - Ensure code quality

• :no_entry_sign: :poop: lint-staged + :dog: husky - Ensure code quality on each git commit and push

• :trophy: badgen - Readme badges

• Workflow to test your CLI tool locally before publishing

:wrench: Usage

npx make-cli-tool <tool-name> [options]

Usage with npx ensures that you are always using the latest version

make-cli-tool will do the following:

• Create a new folder called <tool-name>
• Copy all template files to that folder
• Install the dependencies
• Make an initial commit

Before you start

If you intend to publish this to npm, then you should check the availability of your name with npm-name-cli:

npx npm-name-cli <tool-name>

Example usage

npx make-cli-tool my-tool

What to do after the script is run

• Add a license: https://help.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository

• Update the repository field in package.json:

"repository": {
  "type": "git",
  "url": "git+https://github.com/sajmoni/make-cli-tool.git"
},

This is required for np to be able to publish a changelog

• Set your repository URL

You might also want to

• Update the keywords section in package.json, this helps people find your package on npm.

• Add or remove badges: https://badgen.net/

Things you might want to do if your tool becomes popular

Documentation

If you need more advanced documentation, including a blog and translations, one good option is docosaurus.

Add GitHub issue and PR templates

https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates

Requirements

node >= 16