Skip to content

CustomCommandConfig

Defined in: core/dist/config/types.d.ts:639

Configuration for a custom command. Custom commands can be executed with or without parameters.

command: string

Defined in: core/dist/config/types.d.ts:645

The shell command to execute. Can include placeholders like ${paramName} that will be replaced with parameter values. If no placeholder is present and parameters are provided, they are appended to the command.


description: string

Defined in: core/dist/config/types.d.ts:649

Description of what this command does, shown to the model.


optional parameters?: Record<string, CustomCommandParameter>

Defined in: core/dist/config/types.d.ts:655

Optional parameters that the model can provide when calling this command. Each parameter has a name (the key) and a description. Parameters are validated for security (no shell injection, directory traversal, etc.).


optional timeout?: number

Defined in: core/dist/config/types.d.ts:661

Optional timeout in seconds. When set, the command will be killed if it exceeds this duration. When omitted, no timeout is applied.