import * as cliffy from "https://deno.land/x/cliffy@v0.24.3/mod.ts";
Classes
Completion list type. | |
Boolean type with auto completion. Allows | |
c Cell | Cell representation. |
Checkbox prompt representation. | |
String type with auto completion of child command names. | |
Generates shell completion scripts for various shells. | |
Confirm prompt representation. | |
Enum type. Allows only provided values. | |
Integer type. | |
Generic input prompt representation. | |
Generic list prompt representation. | |
Generic prompt representation. | |
Generates well formatted and colored help output for specified command. | |
Input prompt representation. | |
c List | List prompt representation. |
Number prompt representation. | |
Number type. | |
c Row | Row representation. |
Secret prompt representation. | |
Select prompt representation. | |
String type. Allows any value. | |
Table representation. | |
Toggle prompt representation. | |
Base class for custom types. | |
Enums
Available build-in argument types. |
Variables
v ansi | Chainable ansi escape sequences. If invoked as method, a new Ansi instance will be returned. |
v bel | Ring audio bell: |
Boolean type handler. Excepts | |
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. | |
v tty | Chainable ansi escape sequences. 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. | |
f link | 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. | |
Environment variable options | |
Image options. | |
Input prompt options. | |
Command option settings. | |
Parser options. | |
Result of | |
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 | |
Type Aliases
T Ansi | Chainable ansi escape sequences. If invoked as method, a new Ansi instance will be returned. |
Create new | |
Checkbox options type. | |
Checkbox option settings type. | |
Chainable colors module.
If invoked as method, a new | |
Chainable colors instance returned by all ansi escape properties. | |
Create new | |
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 | |
T IRow | Row type |
Table type. | |
Custom type handler/parser. | |
Version callback method to print the version.
Invoked by the | |
List key options. | |
Secret key options. | |
Select key options. | |
Select option options. | |
Select option settings. | |
Select options type. | |
Select option settings type. | |
T Tty | Chainable ansi escape sequences. If invoked as method, a new Tty instance will be returned. |
Create new | |
Prompt validation return tape. | |