Interface CommandOptions

Path base, template context, and controlled arguments used when constructing a job command.

interface CommandOptions {
    configRoot: string;
    context?: TemplateContext | null;
    controlled?: string[];
    defaultPositional?: string;
}

Properties

configRoot: string

Directory relative path options resolve against.

context?: TemplateContext | null

Values available to dotted-path templates; null disables context-based rendering.

controlled?: string[]

Options the trigger sets itself; config keys for them are ignored with a warning. Default: ['help'].

defaultPositional?: string

A template for the tool's first argument when the config gives none and positionals is not set, e.g. '${media.path}' to feed in a dropped file.