@oclif/help

What is @oclif/help?

@oclif/help is a package designed to generate help documentation for CLI applications built with the Oclif framework. It provides a structured way to display command usage, options, and examples, making it easier for users to understand how to use the CLI tool.

What are @oclif/help's main functionalities?

Generate Command Help

This feature allows you to generate help documentation for a specific command. The code sample demonstrates how to create a CommandHelp instance and generate the help text for a command with flags.

const { CommandHelp } = require('@oclif/help');
const command = { id: 'mycommand', description: 'This is my command', usage: 'mycommand [options]', flags: { flag1: { description: 'First flag' }, flag2: { description: 'Second flag' } } };
const help = new CommandHelp(command);
console.log(help.generate());

Generate CLI Help

This feature allows you to generate help documentation for the entire CLI application. The code sample shows how to create a Help instance with a configuration object containing multiple commands and generate the help text for the CLI.

const { Help } = require('@oclif/help');
const config = { commands: [{ id: 'mycommand', description: 'This is my command' }, { id: 'anothercommand', description: 'This is another command' }] };
const help = new Help(config);
console.log(help.generate());

Other packages similar to @oclif/help

commander

Commander is a popular package for building CLI applications in Node.js. It provides built-in support for generating help documentation, but it is more focused on command parsing and execution. Compared to @oclif/help, Commander offers a more integrated approach to building and documenting CLI tools.

yargs

Yargs is another widely-used package for building CLI applications. It offers extensive features for argument parsing and command handling, along with built-in help generation. Yargs is more feature-rich in terms of argument parsing compared to @oclif/help, but it may require more configuration to achieve similar help documentation.

meow

Meow is a minimalistic package for building CLI applications. It provides a simple way to parse arguments and generate help text. Meow is less feature-rich compared to @oclif/help, but it is easier to set up and use for smaller CLI tools.

README

@oclif/help

This library has been replaced by @oclif/core and is now in maintenance mode. We will only consider PRs that address security concerns.

standard help for oclif

Changelog

1.0.15 (2023-08-05)

Bug Fixes

• deps: bump @oclif/config from 1.18.15 to 1.18.16 (7da3073)