Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@oclif/plugin-help
Advanced tools
The @oclif/plugin-help package is designed to provide a help system for CLI (Command Line Interface) applications built with the oclif (Open CLI Framework). It allows developers to automatically generate and customize help output for their CLI commands.
Automatic help generation
This feature automatically generates help text for a specific command within an oclif CLI application. The help text includes the command's description, usage, arguments, flags, and examples.
const { Command, flags } = require('@oclif/command');
const Help = require('@oclif/plugin-help').default;
class MyCommand extends Command {
async run() {
// your command logic here
}
}
MyCommand.description = 'Description of my command';
const help = new Help(this.config);
help.showHelp(['mycommand']);
Custom help classes
Developers can extend the default Help class to create custom help output. This allows for greater control over the formatting and content of the help text displayed to the user.
const { Command } = require('@oclif/command');
const { Help } = require('@oclif/plugin-help');
class MyHelpClass extends Help {
// override methods to customize help output
}
class MyCommand extends Command {
static helpClass = MyHelpClass;
async run() {
// your command logic here
}
}
Yargs is a powerful npm package that helps you build interactive command line tools, by parsing arguments and generating an elegant user interface. It provides features similar to @oclif/plugin-help, such as automatic help generation and command-specific help, but it is a more general-purpose CLI framework.
Commander is another npm package for node.js designed to make it easy to write full-featured command line applications. It also automatically generates help information for commands. Commander is less opinionated than oclif and does not enforce a specific project structure.
Caporal is a full-featured framework for building command line applications (CLI) with Node.js, which includes a powerful help system. It provides a similar level of abstraction as oclif and includes automatic help generation, but with a different API design and feature set.
FAQs
Standard help for oclif.
The npm package @oclif/plugin-help receives a total of 1,271,708 weekly downloads. As such, @oclif/plugin-help popularity was classified as popular.
We found that @oclif/plugin-help demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.