mediaforge - v2.2.0
    Preparing search index...

    Interface CliTask

    interface CliTask {
        name: string;
        summary: string;
        usage: string;
        flags: Record<string, string>;
        positionals: string[];
        run(pos: string[], flags: CliFlags): void | Promise<void>;
    }
    Index

    Methods

    • Run the command. Commands that only print or validate synchronously return void; everything that shells out to ffmpeg returns a promise.

      Parameters

      Returns void | Promise<void>

    Properties

    name: string

    Subcommand name.

    summary: string

    One-line description for mediaforge help.

    usage: string

    Usage line.

    flags: Record<string, string>

    flag -> description shown in help.

    A description beginning with = marks a flag that requires a value; every other flag is boolean and never consumes the following argument. That declaration is authoritative — buildFlagSpec reads it and the parser acts on it, so analyze --json input.mp3 parses input.mp3 as a positional.

    positionals: string[]

    Positional argument names, in order, for help text.