Update the status bar
The status bar is the last line of the terminal. cli apps can use this to show status information, progress bars, etc. The status bar is kept intact by all semantic cli output.
cli_status( msg, msg_done = paste(msg, "... done"), msg_failed = paste(msg, "... failed"), .keep = FALSE, .auto_close = TRUE, .envir = parent.frame(), .auto_result = c("clear", "done", "failed") )
The text to show, a character vector. It will be collapsed into a single string, and the first line is kept and cut to
console_width(). The message is often associated with the start of a calculation.
The message to use when the message is cleared, when the calculation finishes successfully. If
"done", then this is printed automatically then the calling function (or
The message to use when the message is cleared, when the calculation finishes unsuccessfully. If
"failed", then this is printed automatically then the calling function (or
What to do when this status bar is cleared. If
TRUEthen the content of this status bar is kept, as regular cli output (the screen is scrolled up if needed). If
FALSE, then this status bar is deleted.
Whether to clear the status bar when the calling function finishes (or <U+2018>.envir<U+2019> is removed from the stack, if specified).
Environment to evaluate the glue expressions in. It is also used to auto-clear the status bar if
What to do when auto-closing the status bar.
cli_status_clear() to clear the status bar.
Often status messages are associated with processes. E.g. the app starts
downloading a large file, so it sets the status bar accordingly. Once the
download is done (or failed), the app typically updates the status bar
again. cli automates much of this, via the
.auto_result arguments. See examples below.
The id of the new status bar container element, invisibly.
cli_process_start for a higher level interface to the startus bar, that adds automatic styling.