Registry / web-framework / cli-meow-help

cli-meow-help

library4.0.0jsnpmunverified

Generates automatically formatted help text for meow-based CLI applications. v4.0.0 is the current stable release, with moderate release cadence. Key differentiators: it provides a simple declarative API to generate help text by specifying commands, flags, examples, and optional header/footer, avoiding manual formatting. It integrates tightly with meow and requires meow as a peer dependency.

web-framework

npm install cli-meow-help

github ↗package ↗

INSTALL

IMPORT

SIG · CLI-MEOW-HELP

cli-meow-help

web-frameworkjavascriptv4.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

meowHelp

✓ import meowHelp from 'cli-meow-help'

✗ const meowHelp = require('cli-meow-help')

Package is ESM-only from v4.0.0. CommonJS require() will fail.

default

✓ import meowHelp from 'cli-meow-help'

✗ const { meowHelp } = require('cli-meow-help')

The package exports a single default function. Named destructure does not work.

type

✓ import type { HelpOptions } from 'cli-meow-help'

TypeScript types are bundled. Use import type for type-only imports.

Demonstrates basic usage of cli-meow-help with meow: defines commands and flags, generates help text, and passes it to meow().

import meow from 'meow'; import meowHelp from 'cli-meow-help'; const commands = { new: { desc: 'Creates a new user account' }, duplicate: { desc: 'Duplicates a user account' } }; const flags = { random: { desc: 'Prints random data', type: 'boolean', default: true } }; const helpText = meowHelp({ name: 'cli-command', flags, commands }); meow(helpText, { flags }); // Run `node cli.js --help` to see the auto-formatted help text.

meow --version

Debug

Known issues

breakingESM-only since v4.0.0 – CommonJS require() will throw ERR_REQUIRE_ESM.

fix

Switch to import statement: import meowHelp from 'cli-meow-help'

affects: >=4.0.0

deprecatedThe 'defaults' option (boolean) was deprecated in v3.0.0 and removed in v4.0.0.

fix

Remove the 'defaults' option from meowHelp() call.

affects: >=3.0.0

deprecatedThe 'desc' option (string) is optional in v4.0.0; previously it was required.

fix

Omit 'desc' if not needed, or pass as string.

affects: >=4.0.0

gotchaPackage requires meow as a peer dependency. Forgetting to install meow leads to import error.

fix

Run: npm install meow

affects: >=1.0.0

Errors

Common errors & fixes

ERR_REQUIRE_ESM

Using require() to import an ESM-only package in v4.0.0.

fix

Replace const meowHelp = require('cli-meow-help') with import meowHelp from 'cli-meow-help'

Cannot find module 'meow'

meow is not installed as a dependency.

fix

Run: npm install meow

The 'defaults' option is no longer supported. Please remove it.

Using the deprecated 'defaults' option from v3 or earlier in v4.

fix

Remove the 'defaults' key from the options object passed to meowHelp().

Upgrade

Version history

4.0.0latest on npm

Audit

Dependencies

meowrequiredPeer dependency – cli-meow-help generates help text consumed by meow.

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/ahmadawais/cli-meow-help ↗

packagehttps://www.npmjs.com/package/cli-meow-help ↗