Skip to content
1 min read · 171 words

Interface: SkillScriptParam

Defined in: src/batteries/skills/contracts.ts:46

One validated value in the fixed argv contract presented to a script.

Properties

PropertyModifierTypeDescriptionDefined in
descriptionreadonlystringArgument guidance shown to the model.src/batteries/skills/contracts.ts:50
flag?readonlystringRendered as --flag value when set, otherwise positionally in declaration order.src/batteries/skills/contracts.ts:58
namereadonlystringArgument name used in validation and argv construction.src/batteries/skills/contracts.ts:48
required?readonlybooleanWhether omission is rejected before the child process is started.src/batteries/skills/contracts.ts:56
typereadonly"string" | "number" | "boolean" | "enum"Validation/rendering kind; enum values are constrained separately.src/batteries/skills/contracts.ts:52
values?readonlyreadonly string[]Allowed values, required when SkillScriptParam.type is enum.src/batteries/skills/contracts.ts:54