https://github.com/sindresorhus/node-cli-boilerplate

Boilerplate to kickstart creating a Node.js command-line tool
https://github.com/sindresorhus/node-cli-boilerplate

cli-boilerplate command-line node-boilerplate nodejs npm-package template-repository

Last synced: 9 months ago
JSON representation

Boilerplate to kickstart creating a Node.js command-line tool

Host: GitHub
URL: https://github.com/sindresorhus/node-cli-boilerplate
Owner: sindresorhus
License: mit
Created: 2019-07-02T09:34:13.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-05-02T14:42:47.000Z (over 1 year ago)
Last Synced: 2025-03-31T18:21:20.960Z (9 months ago)
Topics: cli-boilerplate, command-line, node-boilerplate, nodejs, npm-package, template-repository
Language: JavaScript
Homepage:
Size: 6.84 KB
Stars: 257
Watchers: 5
Forks: 12
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license

README

# node-cli-boilerplate

> Boilerplate to kickstart creating a Node.js command-line tool

This is what I use for [my own command-line tools](https://www.npmjs.com/~sindresorhus).

Also check out [`node-module-boilerplate`](https://github.com/sindresorhus/node-module-boilerplate).

## Getting started

**Click the "Use this template" button.**

Alternatively, create a new directory and then run:

```sh
curl -fsSL https://github.com/sindresorhus/node-cli-boilerplate/archive/main.tar.gz | tar -xz --strip-components=1
```

---

**Remove everything from here and above**

---

# unicorn-fun-cli

> My awesome command-line tool

## Install

```sh
npm install --global unicorn-fun-cli
```

## Usage

```
$ unicorn-fun --help

Usage
$ unicorn-fun [input]

Options
--postfix Lorem ipsum [Default: rainbows]

Examples
$ cli-name
unicorns & rainbows
$ cli-name ponies
ponies & rainbows
```