clyops Node API
    Preparing search index...

    Interface Tool

    A probed executable or leaf command, with its effective inherited schema.

    interface Tool {
        description: string;
        file: string;
        kind: Kind;
        name: string;
        schema: Schema;
        subcommand?: string[];
        words: string[];
    }

    Hierarchy (View Summary)

    Index
    description file kind name schema subcommand? words
    description: string

    The first line of its description.

    file: string

    Absolute executable path.

    kind: Kind

    Source classification: tool, dispatcher, or other.

    name: string

    Program, command, option, or argument name as declared in its containing type.

    schema: Schema

    Effective schema returned by the executable and inherited command options.

    subcommand?: string[]

    For a command of a program (spec section 1.7), its words, given to the program before the options: db migrate. schema is then the command's, with the options it inherits.

    words: string[]

    Words from the root to this command, e.g. ['media', 'to-pcm'].

    Settings
    Member Visibility

    On This Page
    Properties