commands

Documentation

Index

• Constants
• type Options
  • func New(opts ...Options) *Options
  • func (o *Options) Play(cast *asciicast.Asciicast) error
  • func (o *Options) Rec() (*asciicast.Asciicast, *bytes.Buffer, error)
• type PlayCommand
  • func NewPlayCommand() *PlayCommand
  • func (c *PlayCommand) Execute(cast *asciicast.Asciicast, maxWait float64) error
• type RecordCommand
  • func NewRecordCommand(env map[string]string) *RecordCommand
  • func (c *RecordCommand) Execute(command, title string, assumeYes bool, maxWait float64) (asciicast.Asciicast, error)

Constants

const Version = "1.2.0"

Types

type Options

type Options struct {
	Title   string
	MaxWait float64
	Yes     bool
	Quite   bool
}

Options options to pass to various commands. These are common flags passed to the asciinema cli.

func New

func New(opts ...Options) *Options

New creates a new Options instance.

func (*Options) Play

func (o *Options) Play(cast *asciicast.Asciicast) error

Play plays the given asciicast. Use asciicast.Asciicast to unmarshal read from the asciicast file.

func (*Options) Rec

func (o *Options) Rec() (*asciicast.Asciicast, *bytes.Buffer, error)

Rec records the terminal and returns the asciicast and error.

type PlayCommand

type PlayCommand struct {
	Player asciicast.Player
}

func NewPlayCommand

func NewPlayCommand() *PlayCommand

func (*PlayCommand) Execute

func (c *PlayCommand) Execute(cast *asciicast.Asciicast, maxWait float64) error

type RecordCommand

type RecordCommand struct {
	Env      map[string]string
	Recorder asciicast.Recorder
}

func NewRecordCommand

func NewRecordCommand(env map[string]string) *RecordCommand

func (*RecordCommand) Execute

func (c *RecordCommand) Execute(command, title string, assumeYes bool, maxWait float64) (asciicast.Asciicast, error)