Skip to content

Main Navigation Guide

Completions Plugin

Friendly Error Plugin

Not Found Plugin

Strict Flags Plugin

Update Notifier Plugin

@clerc/advanced-types

@clerc/plugin-completions

@clerc/plugin-friendly-error

@clerc/plugin-help

@clerc/plugin-not-found

@clerc/plugin-strict-flags

@clerc/plugin-update-notifier

@clerc/plugin-version

English

English

Appearance

Sidebar Navigation

Go back to guide

API Reference

CommandHelpOptions

defaultFormatters

FlagHelpOptions

GroupDefinition

GroupsOptions

HelpOptions

helpPlugin

HelpPluginOptions

This page

Are you an LLM? You can read better optimized documentation at /reference/api/plugin-help/Function.helpPlugin.md for this page in Markdown format

Function: helpPlugin()

ts

function helpPlugin
(__namedParameters
): Plugin;

Defined in: index.ts:107

Parameters

Parameter	Type
`__namedParameters`	`HelpPluginOptions`

Returns

Plugin

Suggest to this page

Pager

PreviousHelpOptions

NextHelpPluginOptions

Released under the MIT license

Copyright © 2023-present Clerc Developers