@gud/cli
    Preparing search index...

    Interface RunParams

    Params for the run function.

    interface RunParams {
        client?: Client;
        command?: string | string[];
        commandsDir?: string;
        defaultCommand?: string | string[];
        hooks?: Partial<LifecycleHooks>;
        initialData?: unknown;
        options?: OptionsConfig;
        parseFn?: ParseCommandFn;
        plugins?: Plugin[];
        resolveFn?: ResolveCommandFn;
    }
    Index

    Properties

    client? command? commandsDir? defaultCommand? hooks? initialData? options? parseFn? plugins? resolveFn?

    Properties

    client?: Client

    The client instance to use for logging and user interaction.

    new Client()
    command?: string | string[]

    The command string or array to be parsed and executed. If not provided, it defaults to system arguments.

    commandsDir?: string

    A directory path containing command modules.

    ${process.cwd()}/commands || ${__dirname}/commands

    defaultCommand?: string | string[]

    The default command string to run if no command is provided.

    hooks?: Partial<LifecycleHooks>

    Optional lifecycle hooks to customize command execution.

    initialData?: unknown

    Initial context or data to pass to commands during execution.

    options?: OptionsConfig

    Options to include in the context.

    parseFn?: ParseCommandFn

    An optional function to replace the default command parser.

    plugins?: Plugin[]

    An array of plugins that can modify or augment the behavior of commands.

    resolveFn?: ResolveCommandFn

    An optional function to replace the default command resolver.

    Settings

    Member Visibility

    On This Page

    Properties