castwright

[!WARNING] This project is still in the early stages of development and is not yet ready for use.

🎥 Scripted terminal recording.

Introduction

[!NOTE] The name castwright is a portmanteau of asciicast and playwright.

Have you re-recorded the same session over and over again, either to hit the right speed or to avoid mistakes? Ever wanted to automate the process of recording terminal sessions, like shell scripts automate the process of running commands? Well, castwright is here to help.

Features

Painless scripting: castwright scripts are very intuitive and similar to an interactive shell, making it easy to understand, write, and maintain.

Installation

TBD

Usage

Usage: castwright [-i <input>] [-o <output>]

🎥 Scripted terminal recording.

Options:
  -i, --input       the path to the input file (castwright script `.cw`), or
                    stdin if not provided
  -o, --output      the path to the output file (asciicast `.cast`), or stdout
                    if not provided
  --help, help      display usage information

Reference

See REFERENCE.md for a detailed reference of the castwright script format (.cw).

TODO

Implement the castwright script parser.
Write to an asciicast file.
Terminal width and height detection.
Better pub API.
Dry-run mode. (Print the commands to be executed without actually executing them)
Actual command execution and output capture.

castwright 0.0.1-alpha.2