Module

x/cliffy/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@v0.20.1/mod.ts";

Classes

Completion list type.

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

Cell representation.

Checkbox prompt representation.

String type with auto completion of child command names.

Generates shell completion scripts for various shell's.

Confirm prompt representation.

Enum type. Allows only provided values.

c
GenericInput
abstract

Generic input prompt representation.

c
GenericList
abstract

Generic list prompt representation.

c
GenericPrompt
abstract

Generic prompt representation.

Generates well formatted and colored help output for specified command.

Input prompt representation.

List prompt representation.

Number prompt representation.

Number type.

Row representation.

Secret prompt representation.

Select prompt representation.

String type. Allows any value.

Table representation.

Toggle prompt representation.

c
Type
abstract

Base class for custom types.

Enums

Available build-in argument types.

Variables

Chainable ansi escape sequence's. If invoked as method, a new Ansi instance will be returned.

Ring audio bell: \u0007

Boolean type handler. Excepts true, false, 1, 0

Clear the terminal screen. (Viewport)

Clear the whole terminal, including scrollback buffer. (Not just the visible part of it).

Hide cursor.

Move cursor to first column of current row.

Get cursor position.

Restore cursor.

Save cursor.

Show cursor.

Clear current line.

Clear to line end.

Clear to line start.

Clear screen.

Prompt icons.

Base key mapping.

Ctrl key mapping.

Shift key mapping.

Number type handler. Excepts any numeric value.

Special key mapping.

String type handler. Excepts any value.

Chainable ansi escape sequence's. If invoked as method, a new Tty instance will be returned.

Functions

Move cursor backward by n lines.

Move cursor down by n lines.

Move cursor forward by n lines.

Move cursor by offset.

Move cursor to the beginning of the line n lines down.

Move cursor to the beginning of the line n lines up.

Move cursor to x, y, counting from the top left corner.

Move cursor up by n lines.

Clear screen down by n lines.

Clear screen and move cursor by n lines up and move cursor to first column.

Clear screen up by n lines.

Get cursor position.

Create image.

Inject prompt values. Can be used for unit tests or pre selections.

Create link.

Parse ansi escape sequence.

Parse command line arguments.

Scroll window down by n lines.

Scroll window up by n lines.

Flags post validation. Validations that are not already done by the parser.

Interfaces

Ansi instance returned by all ansi escape properties.

Chainable ansi escape method declarations.

Checkbox key options.

Checkbox option options.

Checkbox prompt options.

Checkbox option settings.

Confirm prompt options.

Cursor position.

Cursor position options.

Input keys options.

Generic input prompt options.

Generic input prompt settings.

Select key options.

Generic list option options.

Generic list prompt options.

Generic list option settings.

Generic list prompt settings.

Input keys options.

Generic prompt options.

Generic prompt settings.

Global prompt options.

Argument details.

Cell options.

Command option options.

Completion options.

Completion settings.

Environment variable settings.

Environment variable options

Example settings.

Flag argument definition.

Flag options.

Result of the parseFlags method.

Image options.

Input prompt options.

Command option settings.

Parser options.

Result of cmd.parse() method.

Row options.

Table options.

Table settings.

Type settings.

Type details.

Type options.

List prompt options.

Number key options.

Number prompt options.

Secret prompt options.

Select prompt options.

Select prompt settings.

Static generic prompt interface.

Toggle key options.

Generic prompt options.

Ansi instance returned by all ansi escape properties.

Create new Ansi instance.

Type Aliases

Chainable ansi escape sequence's. If invoked as method, a new Ansi instance will be returned.

Create new Ansi instance.

Checkbox options type.

Checkbox option settings type.

Chainable colors module. If invoked as method, a new Colors instance will be returned.

Chainable colors instance returned by all ansi escape properties.

Create new Colors instance.

Action handler for commands and options.

Border characters settings.

Cell type

Type parser method.

Json row.

Default flag value

Description handler.

Value handler for custom value processing.

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

Row type

Table type.

Custom type handler/parser.

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

List key options.

Secret key options.

Select key options.

Select option options.

Select option settings.

Select options type.

Select option settings type.

Chainable ansi escape sequence's. If invoked as method, a new Tty instance will be returned.

Create new Tty instance.

Prompt validation return tape.