Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/powar/deps.ts>cliffy.Command#helpOption

A simple but powerful TypeScript-based dot-file manager.
kontheocharis/powar-ts
Go to Latest
method cliffy.Command.prototype.helpOption
Re-export
import { cliffy } from "https://deno.land/x/powar@1.0.1/deps.ts";
const { Command } = cliffy;

Disable help option.

Parameters

enable: false

Set global help option.

Parameters

flags: string

The flags of the help option.

optional
desc: string

The description of the help option.

optional
opts: OptionOptions<Partial<TCommandOptions>, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand> & { global: true; }

Help option options.

Set help option.

Parameters

flags: string

The flags of the help option.

optional
desc: string

The description of the help option.

optional
opts: OptionOptions<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>

Help option options.

Set help option.

Parameters

flags: string

The flags of the help option.

optional
desc: string

The description of the help option.

optional
opts: ActionHandler<TCommandOptions, TCommandArguments, TCommandGlobals, TParentCommandGlobals, TCommandTypes, TCommandGlobalTypes, TParentCommandTypes, TParentCommand>

The action of the help option.