typescript-npm-cli-template
Boilerplate to kickstart creating a Node.js command-line tool
Inspired by node-cli-boilerplate
Getting started
Set up your repository
Click the "Use this template" button.
Alternatively, create a new directory and then run:
curl -fsSL https://github.com/ryansonshine/typescript-npm-cli-template/archive/main.tar.gz | tar -xz --strip-components=1
Replace FULL_NAME
, GITHUB_USER
, and REPO_NAME
in the script below with your own details to personalize your new package:
FULL_NAME="John Smith"
GITHUB_USER="johnsmith"
REPO_NAME="my-cool-package"
sed -i.mybak "s/\([\/\"]\)(ryansonshine)/$GITHUB_USER/g; s/typescript-npm-cli-template\|my-cli-name/$REPO_NAME/g; s/Ryan Sonshine/$FULL_NAME/g" package.json package-lock.json README.md
rm *.mybak
Add NPM Token
Add your npm token to your GitHub repository secrets as NPM_TOKEN
.
Add Codecov integration
Enable the Codecov GitHub App here.
Remove everything from here and above
my-cli-name
My awesome command-line tool
Install
npm install my-cli-name
Usage
Usage: my-command [options]
Options:
-V, --version output the version number
-d, --debug enables verbose logging (default: false)
Examples:
$ my-command --version
1.0.0