https://github.com/betahuhn/node-cli-starter

💻 Starter repo for Node.js based CLI program
https://github.com/betahuhn/node-cli-starter

cli nodejs starter template

Last synced: 12 months ago
JSON representation

💻 Starter repo for Node.js based CLI program

• Host: GitHub
• URL: https://github.com/betahuhn/node-cli-starter
• Owner: BetaHuhn
• License: mit
• Created: 2021-03-25T19:02:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-16T18:07:27.000Z (over 3 years ago)
• Last Synced: 2025-07-10T16:45:51.750Z (12 months ago)
• Topics: cli, nodejs, starter, template
• Language: JavaScript
• Homepage: https://mxis.ch
• Size: 413 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


  

# 💻 Node CLI Starter


[![Node CI](https://github.com/BetaHuhn/node-cli-starter/workflows/Node%20CI/badge.svg)](https://github.com/BetaHuhn/node-cli-starter/actions?query=workflow%3A%22Node+CI%22) [![Release CI](https://github.com/BetaHuhn/node-cli-starter/workflows/Release%20CI/badge.svg)](https://github.com/BetaHuhn/node-cli-starter/actions?query=workflow%3A%22Release+CI%22) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/BetaHuhn/node-cli-starter/blob/master/LICENSE) ![David](https://img.shields.io/david/betahuhn/node-cli-starter)

Starter repo for Node.js based CLI program



## 🚀 Features

- Permanent configuration with [configstore](https://github.com/yeoman/configstore)

- Command and argument handling with [commander](https://github.com/tj/commander.js)

- Compile program into a single file with [ncc](https://github.com/vercel/ncc)

- Elegant output with [ora](https://github.com/sindresorhus/ora) and input with [prompt-sync](https://github.com/heapwolf/prompt-sync)

- Semantic Release to GitHub and NPM (via GitHub Actions)

- Linting with [Eslint](https://eslint.org/)

- Automatic Dependabot PR merging (via GitHub Actions)

## 💻 Development

- run `yarn lint` or `npm run lint` to run eslint.

- run `npm link` to setup the program for development.

- run `yarn build` or `npm run build` to produce a compiled version in the `dist` folder.

## ❔ About

This project was developed by me ([@betahuhn](https://github.com/BetaHuhn)) in my free time. If you want to support me:

[![Donate via PayPal](https://img.shields.io/badge/paypal-donate-009cde.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=394RTSBEEEFEE)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F81S2RK)

## 📄 License

Copyright 2021 Maximilian Schiller

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.