@compas/cli/src/compas/cli.d.ts

CLI containing utilities and simple script runner

/**
 * Get the compas cli with loaded commands
 *
 * @param {import("@compas/stdlib").InsightEvent} event
 * @param {{
 *   commandDirectories: {
 *     loadScripts: boolean,
 *     loadProjectConfig: boolean,
 *     loadUserConfig: boolean,
 *   }
 * }} options
 */
export function compasGetCli(event: import("@compas/stdlib").InsightEvent, options: {
    commandDirectories: {
        loadScripts: boolean;
        loadProjectConfig: boolean;
        loadUserConfig: boolean;
    };
}): Promise<{
    logger: import("packages/stdlib/src/logger.js").Logger;
    cli: import("../cli/types.js").CliResolved;
}>;
/**
 * Execute CLI
 *
 * @param {import("@compas/stdlib").InsightEvent} event
 * @param {import("@compas/stdlib").Logger} logger
 * @param {import("../cli/types.js").CliResolved} cli
 * @param {Array<string>} userInput
 * @returns {Promise<{
 *   flags?: any,
 *   result: import("@compas/stdlib").Either<import("../cli/types.js").CliResult, { message:
 *   string }>,
 * }>}
 */
export function compasExecCli(event: import("@compas/stdlib").InsightEvent, logger: import("@compas/stdlib").Logger, cli: import("../cli/types.js").CliResolved, userInput: Array<string>): Promise<{
    flags?: any;
    result: import("@compas/stdlib").Either<import("../cli/types.js").CliResult, {
        message: string;
    }>;
}>;
/**
 * Specify internal commands, project command directories, user command directories and
 * scripts directory.
 *
 * @param {{
 *     loadScripts: boolean,
 *     loadProjectConfig: boolean,
 *     loadUserConfig: boolean,
 * }} opts
 * @returns {Promise<Array<{validateOnLoad: boolean, directory: string}>>}
 */
export function getCommandDirectories(opts: {
    loadScripts: boolean;
    loadProjectConfig: boolean;
    loadUserConfig: boolean;
}): Promise<Array<{
    validateOnLoad: boolean;
    directory: string;
}>>;