{"id":13400497,"url":"https://github.com/r-lib/asciicast","last_synced_at":"2025-04-11T22:29:48.637Z","repository":{"id":38420723,"uuid":"197189768","full_name":"r-lib/asciicast","owner":"r-lib","description":"Turn R scripts into terminal screencasts","archived":false,"fork":false,"pushed_at":"2025-03-26T21:41:41.000Z","size":12141,"stargazers_count":235,"open_issues_count":15,"forks_count":11,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T15:25:36.223Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://asciicast.r-lib.org/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/r-lib.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-16T12:28:14.000Z","updated_at":"2025-03-26T20:29:08.000Z","dependencies_parsed_at":"2023-01-24T05:45:21.532Z","dependency_job_id":"23c18fe2-8a87-483d-9887-e45623e44afc","html_url":"https://github.com/r-lib/asciicast","commit_stats":{"total_commits":332,"total_committers":6,"mean_commits":"55.333333333333336","dds":"0.015060240963855387","last_synced_commit":"91d9028d26f8611678665c781f174c952b9ad173"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fasciicast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fasciicast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fasciicast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fasciicast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/r-lib","download_url":"https://codeload.github.com/r-lib/asciicast/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248489309,"owners_count":21112545,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:00:52.662Z","updated_at":"2025-04-11T22:29:48.591Z","avatar_url":"https://github.com/r-lib.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\nalways_allow_html: yes\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE, cache = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\",\n  asciicast_at = \"all\",\n  asciicast_theme = if (Sys.getenv(\"IN_PKGDOWN\") == \"true\") \"pkgdown\" else \"readme\"\n)\nasciicast::init_knitr_engine()\n```\n\n# asciicast\n\n\u003e Turn R scripts into terminal screencasts\n\n\u003c!-- badges: start --\u003e\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n[![CRAN status](https://www.r-pkg.org/badges/version/asciicast)](https://cran.r-project.org/package=asciicast)\n[![Codecov test coverage](https://codecov.io/gh/r-lib/asciicast/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/asciicast?branch=main)\n[![R-CMD-check](https://github.com/r-lib/asciicast/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/asciicast/actions/workflows/R-CMD-check.yaml)\n\u003c!-- badges: end --\u003e\n\nasciicast takes an R script and turns it into an\n[asciinema](https://asciinema.org/) cast. It can simulate typing, and\nrecords all terminal output in real time as it happens.\n\n## Features\n\n* Input is an R script, output is a\n  [v2 asciicast recording](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md).\n* Record all terminal output in real time, as it happens.\n* Simulate typing in the commands, with a configurable, randomized speed.\n* Alternatively, whole comment blocks or expressions can just appear on\n  the screen.\n* Convert casts to SVG images using\n  [svg-term](https://github.com/marionebl/svg-term). The package comes with\n  its own svg-term bundle, no external dependencies are needed.\n* Render a single frame of a cast as an SVG image.\n* Configurable delay at the beginning, at the end and between paragraphs.\n* [HTML widget](http://www.htmlwidgets.org), to be used in Rmarkdown\n  documents, e.g. in vignettes.\n* Read casts from asciinema JSON files (version 2), or from\n  \u003chttps://asciinema.org\u003e directly.\n* Special knitr engine to create R markdown files with ascii casts. See\n  the `asciicast-demo` vignette.\n* Create ascii casts in GitHub READMEs via animated SVG files. See an\n  example in `inst/examples` or the `README.Rmd` source of the README\n  file you are reading.\n\n## Limitations\n\n* asciicast works best in an UTF-8 locale. It also works well if all output\n  is ASCII, but non-ASCII output might cause problems\n  (https://github.com/r-lib/asciicast/issues/36).\n\n## Installation\n\nYou can install the released version of asciicast from\n[CRAN](https://CRAN.R-project.org):\n\n``` r\ninstall.packages(\"asciicast\")\n```\n\n## Examples\n\nSee the [`inst/examples` directory](https://github.com/r-lib/asciicast/tree/main/inst/examples)\nfor these examples.\n\n### Hello world\n\nThe input script:\n\n```{r code = readLines(\"inst/examples/hello.R\"), eval = FALSE}\n```\n\nThe result:\n\n```{asciicast, code = readLines(\"inst/examples/hello.R\"), cache = TRUE}\n```\n\n### Asciicast demo in asciicast\n\nInput script that uses asciicast itself:\n\n```{r code = readLines(\"inst/examples/asciicast.R\"), eval = FALSE}\n```\n\n```{asciicast, code = readLines(\"inst/examples/asciicast.R\"), cache = TRUE}\n```\n\n### Errors are recorded\n\nInput script with errors:\n\n```{r code = readLines(\"inst/examples/errors.R\"), eval = FALSE}\n```\n\n```{asciicast, code = readLines(\"inst/examples/errors.R\"), cache = TRUE}\n```\n\n## Related tools\n\n* asciinema: https://asciinema.org/\n* The original terminal session recorder:\n  https://github.com/asciinema/asciinema\n* svg-term: https://github.com/marionebl/svg-term,\n  https://github.com/marionebl/svg-term-cli\n\n## License\n\nMIT @ [RStudio](https://github.com/rstudio)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lib%2Fasciicast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr-lib%2Fasciicast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lib%2Fasciicast/lists"}