Skip to content

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

License

Notifications You must be signed in to change notification settings

sindresorhus/node-cli-boilerplate

Repository files navigation

node-cli-boilerplate

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

This is what I use for my own command-line tools.

Also check out node-module-boilerplate.

Getting started

Click the "Use this template" button.

Alternatively, create a new directory and then run:

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

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