Function reference • cli

Introduction
`inline-markup`	CLI inline markup
`containers`	CLI containers
`themes`	CLI themes
`faq`	Frequently Asked Questions
Semantic CLI Elements
`cli()`	Compose multiple cli functions
`cli_alert()` `cli_alert_success()` `cli_alert_danger()` `cli_alert_warning()` `cli_alert_info()`	CLI alerts
`cli_blockquote()`	CLI block quote
`cli_bullets()`	List of items
`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_vec()`	Add custom cli style to a vector
`cli_verbatim()`	CLI verbatim text
`format_inline()`	Format and returns a line of 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
`pluralize()`	String templating with pluralization
`no()` `qty()`	Pluralization helper functions
Progress bars
`cli_progress_along()`	Add a progress bar to a mapping function or for loop
`cli_progress_bar()` `cli_progress_update()` `cli_progress_done()`	cli progress bars
`cli_progress_message()`	Simplified cli progress messages
`cli_progress_output()`	Add text output to a progress bar
`cli_progress_step()`	Simplified cli progress messages, with styling
`progress-variables`	Progress bar variables
Progress bars in C/C++
`progress-c`	The cli progress C API
Progress bar utilities
`cli_progress_builtin_handlers()`	cli progress handlers
`cli_progress_demo()`	cli progress bar demo
`cli_progress_styles()`	List of built-in cli progress styles
`cli_progress_num()` `cli_progress_cleanup()`	Progress bar utility functions.
Terminal Colors and Styles
`num_ansi_colors()`	Detect the number of ANSI colors to use
`bg_black()` `bg_blue()` `bg_cyan()` `bg_green()` `bg_magenta()` `bg_red()` `bg_white()` `bg_yellow()` `bg_none()` `col_black()` `col_blue()` `col_cyan()` `col_green()` `col_magenta()` `col_red()` `col_white()` `col_yellow()` `col_grey()` `col_silver()` `col_none()` `style_dim()` `style_blurred()` `style_bold()` `style_hidden()` `style_inverse()` `style_italic()` `style_reset()` `style_strikethrough()` `style_underline()` `style_no_bold()` `style_no_blurred()` `style_no_dim()` `style_no_italic()` `style_no_underline()` `style_no_inverse()` `style_no_hidden()` `style_no_strikethrough()` `style_no_color()` `style_no_bg_color()`	ANSI colored text
`style_hyperlink()` `ansi_has_hyperlink_support()`	Terminal Hyperlinks
`combine_ansi_styles()`	Combine two or more ANSI styles
`make_ansi_style()`	Create a new ANSI style
Styled String Manipulation
`ansi_align()`	Align an ANSI colored string
`ansi_columns()`	Format a character vector in multiple columns
`ansi_has_any()`	Check if a string has some ANSI styling
`ansi_nchar()`	Count number of characters in an ANSI colored string
`ansi_regex()`	Perl comparible regular expression that matches ANSI escape sequences
`ansi_strip()`	Remove ANSI escape sequences from a string
`ansi_strsplit()`	Split an ANSI colored string
`ansi_strtrim()`	Truncate an ANSI string
`ansi_strwrap()`	Wrap an ANSI styled string to a certain width
`ansi_substr()`	Substring(s) of an ANSI colored string
`ansi_substring()`	Substring(s) of an ANSI colored string
`ansi_toupper()` `ansi_tolower()` `ansi_chartr()`	ANSI character translation and case folding
`ansi_trimws()`	Remove leading and/or trailing whitespace from an ANSI string
Signal errors with cli formatting
`cli_abort()` `cli_warn()` `cli_inform()`	Signal an error, warning or message with a cli formatted message
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
Format error, warning and diagnostic messages
`format_error()` `format_warning()` `format_message()`	Format an error, warning or diagnostic message
Rules, Boxes, Trees, etc.
`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
`spark_bar()`	Draw a sparkline bar graph with unicode block characters
`spark_line()`	Draw a sparkline line graph with Braille characters.
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 Terminal 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
`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
cli Configuration
`cli-config`	cli environment variables and options
Debugging cli
`cli_sitrep()`	cli situation report
`cli_debug_doc()`	Debug cli internals
Testing cli
`test_that_cli()`	Test cli output with testthat

Reference

Introduction

Semantic CLI Elements

Themes

Pluralization

Progress bars

Progress bars in C/C++

Progress bar utilities

Terminal Colors and Styles

Styled String Manipulation

Signal errors with cli formatting

Symbols

Applications

Format and print methods with cli

Format error, warning and diagnostic messages

Rules, Boxes, Trees, etc.

Spinners

ANSI Terminal Manipulation

Console Output

Utility Functions

cli Configuration

Debugging cli

Testing cli