npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

meow-helper-cli

v1.0.0

Published

Automatically generate formatted helper text for meow cli helper

Downloads

7

Readme

meow-helper-cli

Automatically generate formatted helper text for meow cli helper

Install

npm

npm install meow meow-helper-cli

npm

yarn add meow meow-helper-cli

Usage

import meow from 'meow';
import meowHelper from meow-helper-cli;

const commands = {
	new: {desc: `Creates a new user account`},
	duplicate: {desc: `Duplicates a my name`}
};

const flags = {
	random: {
		desc: `Prints random info`,
		type: 'boolean',
		default: true
	}
};

const helpText = meowHelper({
	name: `cli-command`,
	flags,
	commands
});

meow(helpText, {flags});

// Now run `cli-command --help` to view the
// following auto formatted & generated help info.

API

meowHelper(options)

❯ options

Type: object

Default: ↓

{
  (name = `(CLI name undefined)`),
    desc,
    (commands = {}),
    (flags = {}),
    (defaults = true),
    header,
    footer;
}

You can specify the options below.

❯ name

Type: string Default: (CLI name undefined)

The bin command name of the cli that's used to run the CLI.

❯ desc

Type: string Default: undefined (optional)

Optionally define a description text for the help message.

❯ commands

Type: string Default: {} (optional)

Optionally, define a JavaScript object containing info on the CLI commands (i.e. meow inputs). Each command has a desc property to define the help text.

❯ flags

Type: string Default: {}

Define CLI options (i.e. meow flags) just like you do with meow which is the flags JavaScript object containing each flag with an extra desc property to define the help text.

❯ defaults

Type: string Default: true (optional)

Prints out the default values of flags. Set to false to disable.

❯ header

Type: string Default: undefined (optional)

Optionally, add additional header information.

❯ footer

Type: string Default: undefined (optional)

Optionally, add additional footer information.

License