Forrest logo
tool overview
On this page you find all important commands for the CLI tool asciinema. If the command you are looking for is missing please ask our AI.

asciinema

Asciinema is a popular command line tool used for recording and sharing terminal sessions. It allows users to capture their command line activities, including commands entered, output displayed, and even text-based user interfaces (TUI).

Here are some key features of asciinema:

  1. Recording: Asciinema records the entire terminal session, capturing each keystroke and its output. It also records the timing and delay between actions, which creates a realistic playback experience for viewers.

  2. Sharing: Once a session is recorded, asciinema generates a unique URL that can be shared with others. This allows users to easily showcase their work or problem-solving skills, especially in technical discussions or support forums.

  3. Embedding: Asciinema provides an option to embed recordings on websites or in documentation. This is especially useful for tutorials, demos, or educational resources where it's helpful to visually demonstrate command line steps.

  4. Playback: Recorded sessions can be played back using the asciinema player, which is available as a standalone tool or an HTML+JavaScript widget. The player offers playback controls like fast-forward, rewind, and pause, enhancing the viewing experience.

  5. Collaboration: Asciinema provides features for multiple users to collaborate on a terminal session. It supports collaborative editing, real-time playback, and allows users to join, watch, or contribute to ongoing sessions.

  6. Privacy: Asciinema respects user privacy by default. Only the user who recorded the session has access to the recording unless specifically shared.

Asciinema is an open-source tool available for various operating systems, including Linux, macOS, and Windows. It can be installed via package managers like pip (Python package manager) or Homebrew (for macOS).

List of commands for asciinema:

  • asciinema:tldr:03080 asciinema: Print the full output of a locally saved recording.
    $ asciinema cat ${filename}.cast
    try on your machine
    explain this command
  • asciinema:tldr:1947d asciinema: Make a new recording (once finished, user will be prompted to upload it or save it locally).
    $ asciinema rec
    try on your machine
    explain this command
  • asciinema:tldr:1b197 asciinema: Make a new recording and save it to a local file.
    $ asciinema rec ${filename}.cast
    try on your machine
    explain this command
  • asciinema:tldr:1c4f9 asciinema: Replay a terminal recording hosted on asciinema.org.
    $ asciinema play https://asciinema.org/a/${cast_id}
    try on your machine
    explain this command
  • asciinema:tldr:256fe asciinema: Associate the local install of `asciinema` with an asciinema.org account.
    $ asciinema auth
    try on your machine
    explain this command
  • asciinema:tldr:867b8 asciinema: Replay a terminal recording from a local file.
    $ asciinema play ${filename}.cast
    try on your machine
    explain this command
  • asciinema:tldr:dbd69 asciinema: Make a new recording, limiting any idle time to at most 2.5 seconds.
    $ asciinema rec -i ${2-5}
    try on your machine
    explain this command
  • asciinema:tldr:fdc3f asciinema: Upload a locally saved terminal session to asciinema.org.
    $ asciinema upload ${filename}.cast
    try on your machine
    explain this command
tool overview