Introduction

inline-markup

CLI inline markup

containers

CLI containers

themes

CLI themes

Semantic CLI Elements

cli_alert() cli_alert_success() cli_alert_danger() cli_alert_warning() cli_alert_info()

CLI alerts

cli_blockquote()

CLI block quote

cli_code()

A block of code

cli_div()

Generic CLI container

cli_dl()

Definition list

cli_end()

Close a CLI container

cli_format()

Format a value for printing

cli_h1() cli_h2() cli_h3()

CLI headings

cli_li()

CLI list item(s)

cli_ol()

Ordered CLI list

cli_par()

CLI paragraph

cli_process_start() cli_process_done() cli_process_failed()

Indicate the start and termination of some computation in the status bar

cli_rule()

CLI horizontal rule

cli_status()

Update the status bar

cli_status_clear()

Clear the status bar

cli_status_update()

Update the status bar

cli_text()

CLI text

cli_ul()

Unordered CLI list

cli_verbatim()

CLI verbatim text

Themes

builtin_theme()

The built-in CLI theme

simple_theme()

A simple CLI theme

cli_list_themes()

List the currently active themes

Pluralization

pluralization

CLI pluralization

no() qty()

Pluralization helper functions

Terminal Colors

bg_black() bg_blue() bg_cyan() bg_green() bg_magenta() bg_red() bg_white() bg_yellow() col_black() col_blue() col_cyan() col_green() col_magenta() col_red() col_white() col_yellow() col_grey() col_silver() style_dim() style_blurred() style_bold() style_hidden() style_inverse() style_italic() style_reset() style_strikethrough() style_underline()

ANSI colored text

combine_ansi_styles()

Combine two or more ANSI styles

make_ansi_style()

Create a new ANSI style

Symbols

symbol list_symbols()

Various handy symbols to use in a command line UI

Applications

start_app() stop_app() default_app()

Start, stop, query the default cli application

Format and print methods with cli

cli_format_method()

Create a format method for an object using cli tools

Rules, Boxes and Trees

rule()

Make a rule with one or two text labels

list_border_styles() boxx()

Draw a banner-like box in the console

tree()

Draw a tree

Spinners

demo_spinners()

Show a demo of some (by default all) spinners

get_spinner()

Character vector to put a spinner on the screen

list_spinners()

List all available spinners

make_spinner()

Create a spinner

ANSI screen manipulation

is_ansi_tty()

Detect if a stream support ANSI escape characters

ansi_hide_cursor() ansi_show_cursor() ansi_with_hidden_cursor()

Hide/show cursor in a terminal

Console Output

cat_line() cat_bullet() cat_boxx() cat_rule() cat_print()

cat() helpers

Utility Functions

cli_output_connection()

The connection option that cli would use

cli_sitrep()

cli situation report

console_width()

Determine the width of the console

is_dynamic_tty()

Detect whether a stream supports \\r (Carriage return)

is_utf8_output()

Whether cli is emitting UTF-8 characters