Interface CliOptions

Program identity, path bases, and environment used when constructing a CLI.

interface CliOptions {
    cwd?: string;
    env?: Record<string, string | undefined>;
    name?: string;
    root?: string;
}

Properties

cwd?: string

Directory command-line paths are relative to. Defaults to process.cwd().

env?: Record<string, string | undefined>

Environment to read option values from. Defaults to process.env.

name?: string

Program name shown in usage. Defaults to the basename of process.argv[1].

root?: string

Base directory for default/env path values and search dirs. Defaults to cwd.