Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/cliffy/command/command.ts>Command#helpOption

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
c4spar/deno-cliffy
Extremely Popular
Go to Latest
method Command.prototype.helpOption
import { Command } from "https://deno.land/x/cliffy@v1.0.0-rc.2/command/command.ts";

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.