ktale-api/ktale.api.commands/CommandDefinition

CommandDefinition

interface CommandDefinition

Declarative command definition.

Design note

This is a pure definition type (no IO). A DSL-friendly builder is expected to live in ktale-core, but this contract is shaped so that builders can target it without depending on any platform details.

Properties

Link copied to clipboard
abstract val aliases: Set<String>

Alternative names that map to this definition.

Link copied to clipboard
abstract val description: String?

Human-readable description.

Link copied to clipboard
abstract val name: String

Primary name for the command (as registered).

Link copied to clipboard
abstract val permission: Permission?

Permission required to execute this command, if any.

Functions

Link copied to clipboard
abstract fun execute(context: CommandContext): CommandResult

Executes the command.