make-cli-tool

A command line tool to create other command line tools (using Node.js)

---

: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 [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
- Copy all template files to that folder
- Install the dependencies
- Make an initial commit

$3

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

`sh
npx npm-name-cli
`

$3

`
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:

`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

$3

- 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

$3

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

$3

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

---

$3

node >= 16`