686 lines
34 KiB
HTML
Raw Normal View History

2025-01-12 00:52:51 +08:00
<!DOCTYPE html>
<html>
<head><title>R: Helpers for Developing Command Line Interfaces</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<link rel="stylesheet" type="text/css" href="R.css" />
</head><body><div class="container">
<h1> Helpers for Developing Command Line Interfaces
<img class="toplogo" src="../../../doc/html/Rlogo.svg" alt="[R logo]" />
</h1>
<hr/>
<div style="text-align: center;">
<a href="../../../doc/html/packages.html"><img class="arrow" src="../../../doc/html/left.jpg" alt="[Up]" /></a>
<a href="../../../doc/html/index.html"><img class="arrow" src="../../../doc/html/up.jpg" alt="[Top]" /></a>
</div><h2>Documentation for package &lsquo;cli&rsquo; version 3.6.3</h2>
<ul><li><a href="../DESCRIPTION">DESCRIPTION file</a>.</li>
<li><a href="../NEWS">Package NEWS</a>.</li>
</ul>
<h2>Help Pages</h2>
<p style="text-align: center;">
<a href="#A">A</a>
<a href="#B">B</a>
<a href="#C">C</a>
<a href="#D">D</a>
<a href="#F">F</a>
<a href="#G">G</a>
<a href="#H">H</a>
<a href="#I">I</a>
<a href="#K">K</a>
<a href="#L">L</a>
<a href="#M">M</a>
<a href="#N">N</a>
<a href="#P">P</a>
<a href="#Q">Q</a>
<a href="#R">R</a>
<a href="#S">S</a>
<a href="#T">T</a>
<a href="#U">U</a>
<a href="#V">V</a>
<a href="#misc">misc</a>
</p>
<h2><a id="A">-- A --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="ansi-styles.html">ansi-styles</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi_align.html">ansi_align</a></td>
<td>Align an ANSI colored string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_toupper.html">ansi_chartr</a></td>
<td>ANSI character translation and case folding</td></tr>
<tr><td style="width: 25%;"><a href="ansi_collapse.html">ansi_collapse</a></td>
<td>Collapse a vector into a string scalar</td></tr>
<tr><td style="width: 25%;"><a href="ansi_columns.html">ansi_columns</a></td>
<td>Format a character vector in multiple columns</td></tr>
<tr><td style="width: 25%;"><a href="ansi_grep.html">ansi_grep</a></td>
<td>Like 'base::grep()' and 'base::grepl()', but for ANSI strings</td></tr>
<tr><td style="width: 25%;"><a href="ansi_grep.html">ansi_grepl</a></td>
<td>Like 'base::grep()' and 'base::grepl()', but for ANSI strings</td></tr>
<tr><td style="width: 25%;"><a href="ansi_has_any.html">ansi_has_any</a></td>
<td>Check if a string has some ANSI styling</td></tr>
<tr><td style="width: 25%;"><a href="style_hyperlink.html">ansi_has_hyperlink_support</a></td>
<td>Terminal Hyperlinks</td></tr>
<tr><td style="width: 25%;"><a href="ansi_hide_cursor.html">ansi_hide_cursor</a></td>
<td>Hide/show cursor in a terminal</td></tr>
<tr><td style="width: 25%;"><a href="ansi_html.html">ansi_html</a></td>
<td>Convert ANSI styled text to HTML</td></tr>
<tr><td style="width: 25%;"><a href="ansi_html_style.html">ansi_html_style</a></td>
<td>CSS styles for the output of 'ansi_html()'</td></tr>
<tr><td style="width: 25%;"><a href="style_hyperlink.html">ansi_hyperlink_types</a></td>
<td>Terminal Hyperlinks</td></tr>
<tr><td style="width: 25%;"><a href="ansi_nchar.html">ansi_nchar</a></td>
<td>Count number of characters in an ANSI colored string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_nzchar.html">ansi_nzchar</a></td>
<td>Like 'base::nzchar()', but for ANSI strings</td></tr>
<tr><td style="width: 25%;"><a href="ansi_palettes.html">ansi_palettes</a></td>
<td>ANSI colors palettes</td></tr>
<tr><td style="width: 25%;"><a href="ansi_palettes.html">ansi_palette_show</a></td>
<td>ANSI colors palettes</td></tr>
<tr><td style="width: 25%;"><a href="ansi_regex.html">ansi_regex</a></td>
<td>Perl compatible regular expression that matches ANSI escape sequences</td></tr>
<tr><td style="width: 25%;"><a href="ansi_hide_cursor.html">ansi_show_cursor</a></td>
<td>Hide/show cursor in a terminal</td></tr>
<tr><td style="width: 25%;"><a href="ansi_simplify.html">ansi_simplify</a></td>
<td>Simplify ANSI styling tags</td></tr>
<tr><td style="width: 25%;"><a href="ansi_string.html">ansi_string</a></td>
<td>Labels a character vector as containing ANSI control codes.</td></tr>
<tr><td style="width: 25%;"><a href="ansi_strip.html">ansi_strip</a></td>
<td>Remove ANSI escape sequences from a string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_strsplit.html">ansi_strsplit</a></td>
<td>Split an ANSI colored string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_strtrim.html">ansi_strtrim</a></td>
<td>Truncate an ANSI string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_strwrap.html">ansi_strwrap</a></td>
<td>Wrap an ANSI styled string to a certain width</td></tr>
<tr><td style="width: 25%;"><a href="ansi_substr.html">ansi_substr</a></td>
<td>Substring(s) of an ANSI colored string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_substring.html">ansi_substring</a></td>
<td>Substring(s) of an ANSI colored string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_toupper.html">ansi_tolower</a></td>
<td>ANSI character translation and case folding</td></tr>
<tr><td style="width: 25%;"><a href="ansi_toupper.html">ansi_toupper</a></td>
<td>ANSI character translation and case folding</td></tr>
<tr><td style="width: 25%;"><a href="ansi_trimws.html">ansi_trimws</a></td>
<td>Remove leading and/or trailing whitespace from an ANSI string</td></tr>
<tr><td style="width: 25%;"><a href="ansi_hide_cursor.html">ansi_with_hidden_cursor</a></td>
<td>Hide/show cursor in a terminal</td></tr>
</table>
<h2><a id="B">-- B --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_black</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_blue</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_black</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_blue</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_cyan</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_green</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_magenta</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_red</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_white</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_br_yellow</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_cyan</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_green</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_magenta</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_none</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_red</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_white</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">bg_yellow</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="boxx.html">boxx</a></td>
<td>Draw a banner-like box in the console</td></tr>
<tr><td style="width: 25%;"><a href="builtin_theme.html">builtin_theme</a></td>
<td>The built-in CLI theme</td></tr>
</table>
<h2><a id="C">-- C --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="cat_line.html">cat_boxx</a></td>
<td>'cat()' helpers</td></tr>
<tr><td style="width: 25%;"><a href="cat_line.html">cat_bullet</a></td>
<td>'cat()' helpers</td></tr>
<tr><td style="width: 25%;"><a href="cat_line.html">cat_line</a></td>
<td>'cat()' helpers</td></tr>
<tr><td style="width: 25%;"><a href="cat_line.html">cat_print</a></td>
<td>'cat()' helpers</td></tr>
<tr><td style="width: 25%;"><a href="cat_line.html">cat_rule</a></td>
<td>'cat()' helpers</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">ccli_tick_reset</a></td>
<td>cli progress bars</td></tr>
<tr><td style="width: 25%;"><a href="cli.html">cli</a></td>
<td>Compose multiple cli functions</td></tr>
<tr><td style="width: 25%;"><a href="cli-config.html">cli-config</a></td>
<td>cli environment variables and options</td></tr>
<tr><td style="width: 25%;"><a href="cli_abort.html">cli_abort</a></td>
<td>Signal an error, warning or message with a cli formatted message</td></tr>
<tr><td style="width: 25%;"><a href="cli_alert.html">cli_alert</a></td>
<td>CLI alerts</td></tr>
<tr><td style="width: 25%;"><a href="cli_alert.html">cli_alert_danger</a></td>
<td>CLI alerts</td></tr>
<tr><td style="width: 25%;"><a href="cli_alert.html">cli_alert_info</a></td>
<td>CLI alerts</td></tr>
<tr><td style="width: 25%;"><a href="cli_alert.html">cli_alert_success</a></td>
<td>CLI alerts</td></tr>
<tr><td style="width: 25%;"><a href="cli_alert.html">cli_alert_warning</a></td>
<td>CLI alerts</td></tr>
<tr><td style="width: 25%;"><a href="cli_blockquote.html">cli_blockquote</a></td>
<td>CLI block quote</td></tr>
<tr><td style="width: 25%;"><a href="cli_bullets.html">cli_bullets</a></td>
<td>List of items</td></tr>
<tr><td style="width: 25%;"><a href="cli_bullets_raw.html">cli_bullets_raw</a></td>
<td>List of verbatim items</td></tr>
<tr><td style="width: 25%;"><a href="cli_code.html">cli_code</a></td>
<td>A block of code</td></tr>
<tr><td style="width: 25%;"><a href="cli_debug_doc.html">cli_debug_doc</a></td>
<td>Debug cli internals</td></tr>
<tr><td style="width: 25%;"><a href="cli_div.html">cli_div</a></td>
<td>Generic CLI container</td></tr>
<tr><td style="width: 25%;"><a href="cli_dl.html">cli_dl</a></td>
<td>Definition list</td></tr>
<tr><td style="width: 25%;"><a href="cli_end.html">cli_end</a></td>
<td>Close a CLI container</td></tr>
<tr><td style="width: 25%;"><a href="cli_fmt.html">cli_fmt</a></td>
<td>Capture the output of cli functions instead of printing it</td></tr>
<tr><td style="width: 25%;"><a href="cli_format.html">cli_format</a></td>
<td>Format a value for printing</td></tr>
<tr><td style="width: 25%;"><a href="cli_format.html">cli_format.character</a></td>
<td>Format a value for printing</td></tr>
<tr><td style="width: 25%;"><a href="cli_format.html">cli_format.default</a></td>
<td>Format a value for printing</td></tr>
<tr><td style="width: 25%;"><a href="cli_format.html">cli_format.numeric</a></td>
<td>Format a value for printing</td></tr>
<tr><td style="width: 25%;"><a href="cli_format_method.html">cli_format_method</a></td>
<td>Create a format method for an object using cli tools</td></tr>
<tr><td style="width: 25%;"><a href="cli_h1.html">cli_h1</a></td>
<td>CLI headings</td></tr>
<tr><td style="width: 25%;"><a href="cli_h1.html">cli_h2</a></td>
<td>CLI headings</td></tr>
<tr><td style="width: 25%;"><a href="cli_h1.html">cli_h3</a></td>
<td>CLI headings</td></tr>
<tr><td style="width: 25%;"><a href="cli_abort.html">cli_inform</a></td>
<td>Signal an error, warning or message with a cli formatted message</td></tr>
<tr><td style="width: 25%;"><a href="cli_li.html">cli_li</a></td>
<td>CLI list item(s)</td></tr>
<tr><td style="width: 25%;"><a href="cli_list_themes.html">cli_list_themes</a></td>
<td>List the currently active themes</td></tr>
<tr><td style="width: 25%;"><a href="cli_ol.html">cli_ol</a></td>
<td>Ordered CLI list</td></tr>
<tr><td style="width: 25%;"><a href="cli_output_connection.html">cli_output_connection</a></td>
<td>The connection option that cli would use</td></tr>
<tr><td style="width: 25%;"><a href="cli_par.html">cli_par</a></td>
<td>CLI paragraph</td></tr>
<tr><td style="width: 25%;"><a href="cli_process_start.html">cli_process_done</a></td>
<td>Indicate the start and termination of some computation in the status bar (superseded)</td></tr>
<tr><td style="width: 25%;"><a href="cli_process_start.html">cli_process_failed</a></td>
<td>Indicate the start and termination of some computation in the status bar (superseded)</td></tr>
<tr><td style="width: 25%;"><a href="cli_process_start.html">cli_process_start</a></td>
<td>Indicate the start and termination of some computation in the status bar (superseded)</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_along.html">cli_progress_along</a></td>
<td>Add a progress bar to a mapping function or for loop</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">cli_progress_bar</a></td>
<td>cli progress bars</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_builtin_handlers.html">cli_progress_builtin_handlers</a></td>
<td>cli progress handlers</td></tr>
<tr><td style="width: 25%;"><a href="progress-utils.html">cli_progress_cleanup</a></td>
<td>Progress bar utility functions.</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_demo.html">cli_progress_demo</a></td>
<td>cli progress bar demo</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">cli_progress_done</a></td>
<td>cli progress bars</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_message.html">cli_progress_message</a></td>
<td>Simplified cli progress messages</td></tr>
<tr><td style="width: 25%;"><a href="progress-utils.html">cli_progress_num</a></td>
<td>Progress bar utility functions.</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_output.html">cli_progress_output</a></td>
<td>Add text output to a progress bar</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_step.html">cli_progress_step</a></td>
<td>Simplified cli progress messages, with styling</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_styles.html">cli_progress_styles</a></td>
<td>List of built-in cli progress styles</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">cli_progress_update</a></td>
<td>cli progress bars</td></tr>
<tr><td style="width: 25%;"><a href="cli_rule.html">cli_rule</a></td>
<td>CLI horizontal rule</td></tr>
<tr><td style="width: 25%;"><a href="cli_sitrep.html">cli_sitrep</a></td>
<td>cli situation report</td></tr>
<tr><td style="width: 25%;"><a href="cli_status.html">cli_status</a></td>
<td>Update the status bar (superseded)</td></tr>
<tr><td style="width: 25%;"><a href="cli_status_clear.html">cli_status_clear</a></td>
<td>Clear the status bar (superseded)</td></tr>
<tr><td style="width: 25%;"><a href="cli_status_update.html">cli_status_update</a></td>
<td>Update the status bar (superseded)</td></tr>
<tr><td style="width: 25%;"><a href="cli_text.html">cli_text</a></td>
<td>CLI text</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">cli_tick_reset</a></td>
<td>cli progress bars</td></tr>
<tr><td style="width: 25%;"><a href="cli_ul.html">cli_ul</a></td>
<td>Unordered CLI list</td></tr>
<tr><td style="width: 25%;"><a href="cli_vec.html">cli_vec</a></td>
<td>Add custom cli style to a vector</td></tr>
<tr><td style="width: 25%;"><a href="cli_verbatim.html">cli_verbatim</a></td>
<td>CLI verbatim text</td></tr>
<tr><td style="width: 25%;"><a href="cli_abort.html">cli_warn</a></td>
<td>Signal an error, warning or message with a cli formatted message</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_bar</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_current</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_current_bytes</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_elapsed</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_elapsed_clock</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_elapsed_raw</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_eta</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_eta_raw</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_eta_str</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_extra</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_id</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_name</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_percent</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_pid</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_rate</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_rate_bytes</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_rate_raw</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_spin</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_status</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_timestamp</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_total</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">cli__pb_total_bytes</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="code_highlight.html">code_highlight</a></td>
<td>Syntax highlight R code</td></tr>
<tr><td style="width: 25%;"><a href="code_theme_list.html">code_theme_list</a></td>
<td>Syntax highlighting themes</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_black</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_blue</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_black</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_blue</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_cyan</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_green</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_magenta</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_red</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_white</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_br_yellow</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_cyan</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_green</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_grey</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_magenta</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_none</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_red</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_silver</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_white</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">col_yellow</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="combine_ansi_styles.html">combine_ansi_styles</a></td>
<td>Combine two or more ANSI styles</td></tr>
<tr><td style="width: 25%;"><a href="console_width.html">console_width</a></td>
<td>Determine the width of the console</td></tr>
<tr><td style="width: 25%;"><a href="containers.html">containers</a></td>
<td>About cli containers</td></tr>
</table>
<h2><a id="D">-- D --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="start_app.html">default_app</a></td>
<td>Start, stop, query the default cli application</td></tr>
<tr><td style="width: 25%;"><a href="demo_spinners.html">demo_spinners</a></td>
<td>Show a demo of some (by default all) spinners</td></tr>
<tr><td style="width: 25%;"><a href="num_ansi_colors.html">detect_tty_colors</a></td>
<td>Detect the number of ANSI colors to use</td></tr>
<tr><td style="width: 25%;"><a href="diff_chr.html">diff_chr</a></td>
<td>Compare two character vectors elementwise</td></tr>
<tr><td style="width: 25%;"><a href="diff_str.html">diff_str</a></td>
<td>Compare two character strings, character by character</td></tr>
</table>
<h2><a id="F">-- F --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="faq.html">faq</a></td>
<td>Frequently Asked Questions</td></tr>
<tr><td style="width: 25%;"><a href="cli_bullets_raw.html">format_bullets_raw</a></td>
<td>List of verbatim items</td></tr>
<tr><td style="width: 25%;"><a href="format_error.html">format_error</a></td>
<td>Format an error, warning or diagnostic message</td></tr>
<tr><td style="width: 25%;"><a href="format_inline.html">format_inline</a></td>
<td>Format and returns a line of text</td></tr>
<tr><td style="width: 25%;"><a href="format_error.html">format_message</a></td>
<td>Format an error, warning or diagnostic message</td></tr>
<tr><td style="width: 25%;"><a href="format_error.html">format_warning</a></td>
<td>Format an error, warning or diagnostic message</td></tr>
</table>
<h2><a id="G">-- G --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="get_spinner.html">get_spinner</a></td>
<td>Character vector to put a spinner on the screen</td></tr>
</table>
<h2><a id="H">-- H --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="hash_animal.html">hash_animal</a></td>
<td>Adjective-animal hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_emoji.html">hash_emoji</a></td>
<td>Emoji hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_md5.html">hash_file_md5</a></td>
<td>MD5 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha1.html">hash_file_sha1</a></td>
<td>SHA-1 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha256.html">hash_file_sha256</a></td>
<td>SHA-256 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_md5.html">hash_md5</a></td>
<td>MD5 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_animal.html">hash_obj_animal</a></td>
<td>Adjective-animal hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_emoji.html">hash_obj_emoji</a></td>
<td>Emoji hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_md5.html">hash_obj_md5</a></td>
<td>MD5 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha1.html">hash_obj_sha1</a></td>
<td>SHA-1 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha256.html">hash_obj_sha256</a></td>
<td>SHA-256 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_animal.html">hash_raw_animal</a></td>
<td>Adjective-animal hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_emoji.html">hash_raw_emoji</a></td>
<td>Emoji hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_md5.html">hash_raw_md5</a></td>
<td>MD5 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha1.html">hash_raw_sha1</a></td>
<td>SHA-1 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha256.html">hash_raw_sha256</a></td>
<td>SHA-256 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha1.html">hash_sha1</a></td>
<td>SHA-1 hash</td></tr>
<tr><td style="width: 25%;"><a href="hash_sha256.html">hash_sha256</a></td>
<td>SHA-256 hash</td></tr>
<tr><td style="width: 25%;"><a href="has_keypress_support.html">has_keypress_support</a></td>
<td>Check if the current platform/terminal supports reading single keys.</td></tr>
</table>
<h2><a id="I">-- I --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="inline-markup.html">inline-markup</a></td>
<td>About inline markup in the semantic cli</td></tr>
<tr><td style="width: 25%;"><a href="is_ansi_tty.html">is_ansi_tty</a></td>
<td>Detect if a stream support ANSI escape characters</td></tr>
<tr><td style="width: 25%;"><a href="is_dynamic_tty.html">is_dynamic_tty</a></td>
<td>Detect whether a stream supports \\r (Carriage return)</td></tr>
<tr><td style="width: 25%;"><a href="is_utf8_output.html">is_utf8_output</a></td>
<td>Whether cli is emitting UTF-8 characters</td></tr>
</table>
<h2><a id="K">-- K --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="keypress.html">keypress</a></td>
<td>Read a single keypress at the terminal</td></tr>
</table>
<h2><a id="L">-- L --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="links.html">links</a></td>
<td>cli hyperlinks</td></tr>
<tr><td style="width: 25%;"><a href="boxx.html">list_border_styles</a></td>
<td>Draw a banner-like box in the console</td></tr>
<tr><td style="width: 25%;"><a href="list_spinners.html">list_spinners</a></td>
<td>List all available spinners</td></tr>
<tr><td style="width: 25%;"><a href="symbol.html">list_symbols</a></td>
<td>Various handy symbols to use in a command line UI</td></tr>
</table>
<h2><a id="M">-- M --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="make_ansi_style.html">make_ansi_style</a></td>
<td>Create a new ANSI style</td></tr>
<tr><td style="width: 25%;"><a href="make_spinner.html">make_spinner</a></td>
<td>Create a spinner</td></tr>
</table>
<h2><a id="N">-- N --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="pluralization-helpers.html">no</a></td>
<td>Pluralization helper functions</td></tr>
<tr><td style="width: 25%;"><a href="num_ansi_colors.html">num_ansi_colors</a></td>
<td>Detect the number of ANSI colors to use</td></tr>
</table>
<h2><a id="P">-- P --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_bar</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_current</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_current_bytes</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_elapsed</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_elapsed_clock</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_elapsed_raw</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_eta</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_eta_raw</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_eta_str</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_extra</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_id</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_name</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_percent</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_pid</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_rate</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_rate_bytes</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_rate_raw</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_spin</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_status</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_timestamp</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_total</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">pb_total_bytes</a></td>
<td>Progress bar variables</td></tr>
<tr><td style="width: 25%;"><a href="pluralization.html">pluralization</a></td>
<td>About cli pluralization</td></tr>
<tr><td style="width: 25%;"><a href="pluralize.html">pluralize</a></td>
<td>String templating with pluralization</td></tr>
<tr><td style="width: 25%;"><a href="pretty_print_code.html">pretty_print_code</a></td>
<td>Turn on pretty-printing functions at the R console</td></tr>
<tr><td style="width: 25%;"><a href="progress-c.html">progress-c</a></td>
<td>The cli progress C API</td></tr>
<tr><td style="width: 25%;"><a href="progress-variables.html">progress-variables</a></td>
<td>Progress bar variables</td></tr>
</table>
<h2><a id="Q">-- Q --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="pluralization-helpers.html">qty</a></td>
<td>Pluralization helper functions</td></tr>
</table>
<h2><a id="R">-- R --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="rule.html">rule</a></td>
<td>Make a rule with one or two text labels</td></tr>
<tr><td style="width: 25%;"><a href="ruler.html">ruler</a></td>
<td>Print the helpful ruler to the screen</td></tr>
</table>
<h2><a id="S">-- S --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="simple_theme.html">simple_theme</a></td>
<td>A simple CLI theme</td></tr>
<tr><td style="width: 25%;"><a href="spark_bar.html">spark_bar</a></td>
<td>Draw a sparkline bar graph with unicode block characters</td></tr>
<tr><td style="width: 25%;"><a href="spark_line.html">spark_line</a></td>
<td>Draw a sparkline line graph with Braille characters.</td></tr>
<tr><td style="width: 25%;"><a href="start_app.html">start_app</a></td>
<td>Start, stop, query the default cli application</td></tr>
<tr><td style="width: 25%;"><a href="start_app.html">stop_app</a></td>
<td>Start, stop, query the default cli application</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_blurred</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_bold</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_dim</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_hidden</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="style_hyperlink.html">style_hyperlink</a></td>
<td>Terminal Hyperlinks</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_inverse</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_italic</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_bg_color</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_blurred</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_bold</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_color</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_dim</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_hidden</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_inverse</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_italic</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_strikethrough</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_no_underline</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_reset</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_strikethrough</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="ansi-styles.html">style_underline</a></td>
<td>ANSI colored text</td></tr>
<tr><td style="width: 25%;"><a href="symbol.html">symbol</a></td>
<td>Various handy symbols to use in a command line UI</td></tr>
</table>
<h2><a id="T">-- T --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="test_that_cli.html">test_that_cli</a></td>
<td>Test cli output with testthat</td></tr>
<tr><td style="width: 25%;"><a href="themes.html">themes</a></td>
<td>About cli themes</td></tr>
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">ticking</a></td>
<td>cli progress bars</td></tr>
<tr><td style="width: 25%;"><a href="tree.html">tree</a></td>
<td>Draw a tree</td></tr>
<tr><td style="width: 25%;"><a href="ansi_palettes.html">truecolor</a></td>
<td>ANSI colors palettes</td></tr>
</table>
<h2><a id="U">-- U --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="utf8_graphemes.html">utf8_graphemes</a></td>
<td>Break an UTF-8 character vector into grapheme clusters</td></tr>
<tr><td style="width: 25%;"><a href="utf8_nchar.html">utf8_nchar</a></td>
<td>Count the number of characters in a character vector</td></tr>
<tr><td style="width: 25%;"><a href="utf8_substr.html">utf8_substr</a></td>
<td>Substring of an UTF-8 string</td></tr>
</table>
<h2><a id="V">-- V --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="vt_output.html">vt_output</a></td>
<td>Simulate (a subset of) a VT-5xx ANSI terminal</td></tr>
</table>
<h2><a id="misc">-- misc --</a></h2>
<table style="width: 100%;">
<tr><td style="width: 25%;"><a href="cli_progress_bar.html">__cli_update_due</a></td>
<td>cli progress bars</td></tr>
</table>
</div></body></html>