cli.ctl File Reference

Command-line interface for Splash recording and playback sessions. More...

Functions
void	main (...)
	Parses the sq-cli command and runs the requested Splash operation.
void	startRecording (CommandLineArguments cli)
	Starts a recorder UI for a panel and stores its script metadata. More...
void	sendSessionCommand (const string command)
	Sends pause or resume to the active recorder session. More...
void	stopRecording (CommandLineArguments cli)
	Stops the current recording and validates the requested output path. More...
bool	getCurrentSession (mapping &panelInfo, mapping &scriptInfo)
	Reads the metadata for the active panel and test script. More...
void	printStatus ()
	Prints current Splash state as a JSON object.
void	printUsage ()
	Prints the supported sq-cli command syntax.
void	logInfo (const string message, const anytype note=NULL, const anytype note2=NULL)
	Logs an informational sq-cli message through OaLogger. More...
void	logWarning (const string message, const anytype note=NULL, const anytype note2=NULL)
	Logs a warning sq-cli message through OaLogger. More...

Detailed Description

Command-line interface for Splash recording and playback sessions.

Copyright

MIT

Attention

This documentation is created with the help of an artificial intelligence.

Function Documentation

getCurrentSession()

bool getCurrentSession	(	mapping &	panelInfo,
		mapping &	scriptInfo
	)

Reads the metadata for the active panel and test script.

Parameters

panelInfo	Parsed panel metadata.
scriptInfo	Parsed test-script metadata.

Returns

true when both paths identify a valid current session.

logInfo()

void logInfo	(	const string	message,
		const anytype	note = NULL,
		const anytype	note2 = NULL
	)

Logs an informational sq-cli message through OaLogger.

Parameters

message	Translatable message text.
note	Optional first substitution value.
note2	Optional second substitution value.

logWarning()

void logWarning	(	const string	message,
		const anytype	note = NULL,
		const anytype	note2 = NULL
	)

Logs a warning sq-cli message through OaLogger.

Parameters

message	Translatable message text.
note	Optional first substitution value.
note2	Optional second substitution value.

sendSessionCommand()

void sendSessionCommand

(

const string

command

)

Sends pause or resume to the active recorder session.

Parameters

command

Splash session command.

startRecording()

void startRecording

(

CommandLineArguments

cli

)

Starts a recorder UI for a panel and stores its script metadata.

Parameters

cli	Parsed command-line arguments.

stopRecording()

void stopRecording

(

CommandLineArguments

cli

)

Stops the current recording and validates the requested output path.

Parameters

cli	Parsed command-line arguments.