Create Rich Command Line Applications

Create rich command line applications, with colors, headings, lists, alerts, progress bars, etc. It uses CSS for custom themes.


lifecycle Linux Build Status Windows Build status CRAN RStudio mirror downloads Coverage Status

Create rich command line applications, with colors, headings, lists, alerts, progress bars, etc. It uses CSS for theming.


install.packages("cliapp")

Usage

This README uses the simple theme, included in the package, see ?simple_theme().

library(cliapp)
start_app(theme = simple_theme())

Headings

cli_h1(), cli_h2() and cli_h3() create three levels of headings:

cli_h1("Title")
cli_h2("Subtitle")
cli_h3("Subsubtitle")

Text and inline markup

All (non-verbatim) outputted text runs through glue::glue(). In addition to glue interpolation, cliapp also supports inline markup via the {markup text} form. The builtin theme defines inline markup classes, see ?inline-markup.

cli_text("{emph Emphasized text}, {strong Strong} importance.
  A piece of code: {code  sum(a) / length(a)}. Package names:
  {pkg cliapp}, file names: {path /usr/bin/env}, etc.")

Alerts

cli_alert("Generic alert")
cli_alert_danger("Something went horribly wrong")
cli_alert_warning("Better watch out!")
cli_alert_info("About to download 1.4GiB of data.")
cli_alert_success("All downloads finished successfully")

Lists

Ordered, unordered and definition lists, they can be nested. See ?cli_ol(), ?cli_ul(), ?cli_dl() and ?cli_it().

cli_div(theme = list(ol = list("margin-left" = 2)))
cli_ul("one", .close = FALSE)
cli_ol(c("foo", "bar", "foobar"))
cli_it("two")
cli_end()
cli_end()

Progress bars

Progress bars are supported via the progress package.

License

MIT © RStudio

News

0.1.0

First public release.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("cliapp")

0.1.0 by Gábor Csárdi, 9 months ago


https://github.com/r-lib/cliapp#readme


Report a bug at https://github.com/r-lib/cliapp/issues


Browse source code at https://github.com/cran/cliapp


Authors: Gábor Csárdi


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports cli, crayon, fansi, glue, prettycode, progress, R6, selectr, utils, withr, xml2

Suggests callr, covr, rstudioapi, testthat


Imported by pak, pkgcache.

Suggested by callr.


See at CRAN