clyops Node API
    Preparing search index...

    Interface Schema

    Root schema with the format discriminator and declared program name.

    interface Schema {
        arguments: SchemaArgument[];
        clyops: number;
        commands?: SchemaCommand[];
        constraints?: SchemaConstraint[];
        description: string;
        effects?: Effect[];
        epilog: string;
        options: SchemaOption[];
        requiredCommands: {
            command: string;
            description: string;
            installHint: string;
        }[];
        script: string;
        stdin?: SchemaStream
        | null;
        stdout?: SchemaStream | null;
    }

    Hierarchy (View Summary)

    Index
    arguments clyops commands? constraints? description effects? epilog options requiredCommands script stdin? stdout?
    arguments: SchemaArgument[]

    Positional arguments in registration order.

    clyops: number

    Schema format discriminator; currently 1.

    commands?: SchemaCommand[]

    Nested commands with their own options, arguments, and metadata.

    constraints?: SchemaConstraint[]

    Declared exclusive, requires, and oneOf option relationships.

    description: string

    Human-readable description shown in help and documentation.

    effects?: Effect[]

    Declared read-only, idempotent, destructive, or network effects.

    epilog: string

    Text shown after the help sections.

    options: SchemaOption[]

    Options declared at this command level, in registration order.

    requiredCommands: { command: string; description: string; installHint: string }[]

    External executables required by the tool, with descriptions and install hints.

    Type Declaration

    • command: string

      Executable name searched for on PATH.

    • description: string

      Why the executable is needed.

    • installHint: string

      Installation instructions when the executable is absent.

    script: string

    Program name declared by the tool, which may differ from its executable path.

    stdin?: SchemaStream | null

    Declared input stream, or null/absent when none is declared.

    stdout?: SchemaStream | null

    Declared output stream, or null/absent when undeclared (text output).

    Settings
    Member Visibility

    On This Page
    Properties