Command line interface

The CLI commands module provides command-line interface functionality for Framecat.

Command line interface

class framecat.cli_interface.InputMode

Bases: object

Class to represent the different modes for input selection.

LATEST

Represents the mode to select the latest input.

Type:

str

BY_NAME

Represents the mode to select input by name.

Type:

str

framecat.cli_interface.execute_command(args)

Executes the rendering process based on the parsed command-line arguments.

This function configures the rendering parameters and determines the input files to process based on the specified input mode (latest or by name). It then calls the render_file function for each input file.

Parameters:

args (Namespace) – A Namespace object containing the parsed command-line arguments.

framecat.cli_interface.parse_args(args)

Parses command-line arguments for video and GIF generation.

This function sets up the argument parser with various options for input modes, input types, file paths, and parameters for GIF and video generation.

Parameters:

args (list) – A list of command-line arguments to parse.

Returns:

Namespace – A Namespace object containing the parsed arguments.