Back to Explore

mcollina/help-me

GitHub
1 watchersOpen source

Last release:

help-me is a Node.js “help” command utility intended to generate help output for Node programs, designed to work with minimist and commist. It reads help text files from a specified directory (defaulting to .txt) and can create streams or print to stdout, with examples for use both directly and via commist’s command system.

Project status

  • Maintenance status: The most recent upstream update is from 2024-02-12, and the last few tagged updates are from 2023-12 and earlier, so the repository looks quiet/dormant rather than actively maintained as of 2026-08-12.
  • Update cadence: Updates appear infrequent (roughly yearly at best based on 2022-12, 2023-12, and a 2024-02 push, with multi-year gaps between some points).

AI summary generated

AI-generated from public sources. May be inaccurate. Report

Recent updates

  • v5.0.0

    v5.0.0 removes the use of the glob package for discovering help files. Instead of using glob to match files, the implementation switches to reading directory contents directly.

  • v4.2.0

    Release v4.2.0 is presented as a small bug fix intended to ensure the default output stream correctly emits streaming events. The code change actually introduces a custom default Writable stream and also switches core stream utilities.

  • v4.1.0

    v4.1.0 updates the help-me utility to make its toStdout helper Promise-based, and adds tests plus README examples. The main behavioral change is in help-me.js, where toStdout now returns a Promise and supports customization hooks for missing help handling.

    BreakingFeatures
  • v4.0.1

    v4.0.1 is a small Windows-focused bug fix release. It updates path handling so help file discovery works correctly when opts.dir is an absolute path on win32.

  • v4.0.0

    v4.0.0 focuses on dependency updates and a few usability fixes. It also includes changes related to matching behavior and ensuring the example and help output work correctly, especially on Windows.