README.md

node-cli-skeleton

Skeleton of CLI Node.js app. Pre-packed with:

• typescript
• jest test framework
• winston logger
• commander CLI arguments parser
• dotenv settings loader

Use the Template

Clone the repository:

git clone --depth=1 https://github.com/onspli/node-cli-skeleton.git my-cli-app
cd my-cli-app
rm -rf .git

Find all occurences of node-cli-skeleton and replace them with my-cli-app.

Build and Run the App

Build the app and test it:

npm install
npm run build
npm test

Run the app:

node dist/main.js

Link the app locally and execute it:

npm link
node-cli-skeleton