Asciicast.jl

Asciicast.jl is all about showcasing Julia code running in a REPL using technologies developed by the open-source asciinema project. (It is totally unaffiliated with the authors of that project, however).

Quick example

using Asciicast
cast"""
    using Pkg
    Pkg.status()
    1 + 1
    """0.25

This example creates a Cast object using the @cast_str macro, which captures the input and the output. Check out Creating casts for more on creating Cast objects (or Cast files for a lower level API, if you are interested).

Here, the Cast object is being rendered by the javascript asciinema-player loaded by Documenter. See Documenter usage for more on that.

Likewise, check out Markdown usage for using Asciicast.jl to generate and maintain gifs of code execution in documents like READMEs.

Table of contents

• Creating casts
• • the @cast_str macro
  • record_output
  • Cast objects and a manual example
  • Saving outputs
• Documenter usage
• • @cast blocks
  • Hiding REPL inputs
  • Exceptions
  • Example with a named block
  • Modifying the delay
  • All supported options in @cast Documenter blocks
  • Reference docs
• Markdown usage
• • julia {cast="true"} code blocks
  • Named blocks
  • All supported attributes
  • Syntax notes
  • Reference docs
• Cast files
• • Reference docs
• Limitations
• • Cannot use keyboard input
  • Cannot rely on stdout (or stderr) in one line being still open in the next
  • Limited emoji support in gifs
  • cast_document effectively reformats the document
  • cast"" blocks require everything to be defined within the block
• Non-limitations
• • ANSI escape codes work properly