Saxonberg Server API
    Preparing search index...

    Interface SubcommandDefinition

    interface SubcommandDefinition {
        args?: PositionalDefinition[];
        controller?: string;
        description?: string;
        examples?: ExampleDefinition[];
        help?: string;
        options?: Record<string, OptionDefinition>;
        validators?: string[];
    }
    Index

    Properties

    args? controller? description? examples? help? options? validators?

    Properties

    args?: PositionalDefinition[]
    controller?: string
    description?: string
    examples?: ExampleDefinition[]

    Worked invocations specific to this subcommand.

    help?: string

    Multi-line authored help prose for this subcommand.

    options?: Record<string, OptionDefinition>
    validators?: string[]

    Subcommand-level validators (YAML path specs). Fire after the verb-level validators and before field validators, with context.commandGiver populated, only when this subcommand is invoked — the subcommand-scoped equivalent of CommandView.validators. An authority gate on one subcommand (a founder-only assign) that leaves the verb's public subcommands ungated.

    Settings

    Member Visibility

    On This Page

    Properties