clyops Node API
    Preparing search index...

    Interface ArgvOptions

    Controls path resolution, templates, positional order, secret transport, and allowed path boundaries.

    interface ArgvOptions {
        base?: string;
        controlled?: string[];
        cwd?: string;
        positionals?: string[] | "first" | "last";
        positionalsOrder?: "first" | "last";
        render?: (value: string) => string;
        secretEnv?: boolean;
        within?: string[];
    }
    Index
    base? controlled? cwd? positionals? positionalsOrder? render? secretEnv? within?
    base?: string

    Directory that relative path values resolve against (default: leave them to the tool).

    controlled?: string[]

    Option names the caller sets itself; input keys for them are reported in controlled.

    cwd?: string

    The tool's working directory, for within (default: this process's).

    positionals?: string[] | "first" | "last"

    Explicit positional values, or their order (default: 'first').

    positionalsOrder?: "first" | "last"

    Order when also supplying explicit positional values.

    render?: (value: string) => string

    Applied to every string value before it is used (templating).

    secretEnv?: boolean

    Pass secret options (spec section 1.5) in the environment, under their variable names, instead of on the command line where ps shows them. Array options stay on the command line.

    within?: string[]

    Path-valued inputs must resolve inside one of these directories (relative ones against base, else cwd); anything else is an InputError.

    Settings
    Member Visibility

    On This Page
    Properties