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

x/cliffy/command/mod.ts

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
Extremely Popular
Go to Latest
import * as cliffy from "https://deno.land/x/cliffy@v1.0.0-rc.3/command/mod.ts";

Classes

Completion list type.

Generates bash completions script.

Boolean type with auto completion. Allows true, false, 0 and 1.

String type with auto completion of child command names.

Chainable command factory class.

String type with auto completion of sibling command names.

Generates shell completion scripts for various shells.

Enum type. Allows only provided values.

Integer type.

Generates fish completions script.

Generates well formatted and colored help output for specified command.

Integer type.

Number type.

c
Provider
abstract

String type. Allows any value.

c
Type
abstract

Base class for custom types.

Generates zsh completions script.

Interfaces

Argument details.

Argument parsing informations.

Result of cmd.parse() method.

Completion options.

Completion settings.

Environment variable settings.

Environment variable options

Example settings.

Environment variable options

Command option options.

Command option settings.

Type settings.

Type options.

Type Aliases

Action handler for commands and options.

Type parser method.

Default flag value or a callback method that returns the default value.

Description handler.

Description handler.

Help callback method to print the help. Invoked by the --help option and help command and the .getHelp() and .showHelp() methods.

T
IAction
deprecated
T
IArgument
deprecated
T
ICommandOption
deprecated
T
ICompleteHandler
deprecated
T
ICompleteOptions
deprecated
T
ICompletion
deprecated
T
IDescription
deprecated
T
IEnvVar
deprecated
T
IEnvVarOptions
deprecated
T
IExample
deprecated
T
IHelpHandler
deprecated
T
IOption
deprecated
T
IParseResult
deprecated
T
IType
deprecated
T
ITypeOptions
deprecated
T
IVersionHandler
deprecated

Parse method for custom types. Gets the raw user input passed as argument and returns the parsed value.

T
TypeValue
deprecated

Version callback method to print the version. Invoked by the --help option command and the .getVersion() and .showHelp() methods.