recorder

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateHTMLReport

func GenerateHTMLReport(frames []Frame, out io.Writer) error

GenerateHTMLReport creates an interactive HTML report from the recorded frames.

func GenerateMarkdownReport

func GenerateMarkdownReport(frames []Frame, out io.Writer) error

GenerateMarkdownReport creates a markdown report optimized for LLM consumption.

func GenerateMarkdownReportWithANSI

func GenerateMarkdownReportWithANSI(frames []Frame, out io.Writer) error

GenerateMarkdownReportWithANSI creates a markdown report with ANSI codes preserved.

func GenerateXMLReport

func GenerateXMLReport(frames []Frame, out io.Writer) error

GenerateXMLReport creates an XML report optimized for LLM consumption.

func GenerateXMLReportWithANSI

func GenerateXMLReportWithANSI(frames []Frame, out io.Writer) error

GenerateXMLReportWithANSI creates an XML report with ANSI codes preserved.

Types

type Frame

type Frame struct {
	Timestamp time.Duration `json:"timestamp"` // Time since session start.
	Input     string        `json:"input"`     // The user's input (keystrokes).
	Output    string        `json:"output"`    // The raw ANSI output from the application in response to the input.
}

Frame represents a single cause-and-effect step in the recorded session. It links a user's input to the resulting raw ANSI output from the application.

type Recorder

type Recorder struct{}

Recorder manages the recording of a terminal session.

func New

func New() *Recorder

New creates a new Recorder.

func (*Recorder) Run

func (r *Recorder) Run(command []string) ([]Frame, error)

Run executes the command in a PTY and records the session.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL