https://github.com/samhuk/node-cli-template

Node.js CLI App Template
https://github.com/samhuk/node-cli-template

cli commander nodejs template typescript

Last synced: 15 days ago
JSON representation

Node.js CLI App Template

• Host: GitHub
• URL: https://github.com/samhuk/node-cli-template
• Owner: samhuk
• License: mit
• Created: 2023-04-01T12:15:42.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-04-02T10:37:39.000Z (over 1 year ago)
• Last Synced: 2024-12-06T08:35:48.912Z (16 days ago)
• Topics: cli, commander, nodejs, template, typescript
• Language: JavaScript
• Homepage:
• Size: 44.9 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing/development.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-cli-template

This is a template repository for a Node.js CLI application.

* Typescript

* ESLint

* esbuild

* GoodFlow (for error handling) 

## Usage

1. Click the "**Use Template**" button on Github to create your own repository from this template

2. Locally clone your new remote Github repository

3. From the root directory of your new local clone, run `node setup.js`, entering in some details.

4. After it completes, you can remove `setup.js` and this section of the README.

5. Run `npm run build-dev && npm run hello-dev "Joe Bloggs"` to build the CLI and run the `hello` example command.

6. For information on how to develop on your new codebase, see [./contributing/development.md](./contributing/development.md)

7. Have fun!

This template is approximately based off of the architecture of [hey](https://github.com/samhuk/hey) and the CLI of [Exhibitor](https://github.com/samhuk/exhibitor).

If you found this delightful, feel free to [sponsor me on GitHub](https://github.com/sponsors/samhuk) 💕 or [buy me a coffee](https://www.buymeacoffee.com/samhuk) ☕

---

{{app-name}}



  {{app-slogan}}



> Badges like license type and current build status can go here. Uncomment the HTML below within this README to show them.

## Overview

> Provide a quick overview of what your app does.

> If it is a large app, you can put a "Getting Started" wiki page link here.

## Usage

> Provide instructions on how to use your app.

## Development

See [./contributing/development.md](./contributing/development.md)

---

> If desired, briefly mention any donation links here. Here's Buy Me a Coffee as an example:

If you found this package delightful, feel free to [buy me a coffee](https://www.buymeacoffee.com/{{buy-me-a-coffee-user-name}}) ✨