hello-help

boilerplate from modern-npm-package

Get Started

🦄 Hello Help ✨

$ npx hello-help
$ npx hello-help --help

• simple code example at: example/cli.ts

import { HelloHelp, helloHelpCli } from "hello-help";

const helloHelp = new HelloHelp(
  "🦄 hello-help ✨",
  "print your --help option easy",
  {
    hello: {
      optionName: "hello",
      description: "nice to say hello to you 👋",
    },
    heart: {
      optionName: "heart",
      shortenOptionName: "ht",
      description: "need a heart? 🩷",
    },
  }
);

helloHelpCli(helloHelp);

A. command with no --help option

🦄 hello-help ✨
print your --help option easy

B. command with --help option

🦄 hello-help ✨ options
--hello: nice to say hello to you 👋
--heart, -ht: need a heart? 🩷