ketraterm-completion/io.github.ketraterm.completion.model/TerminalCommandSpec

TerminalCommandSpec

data class TerminalCommandSpec @JvmOverloads constructor(val name: String, val description: String = "", val aliases: List<String> = emptyList(), val subcommands: List<TerminalCommandSpec> = emptyList(), val options: List<TerminalOptionSpec> = emptyList(), val positionalArguments: List<TerminalArgumentSpec> = emptyList(), val positionalArgumentPathKind: TerminalPathArgumentKind = TerminalPathArgumentKind.NONE, val positionalArgumentValueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, val positionalArgumentHiddenPathPolicy: TerminalHiddenPathPolicy = TerminalHiddenPathPolicy.DEFAULT, val repeatableSubcommands: Boolean = false)

Declarative command specification consumed by the in-process completion engine.

This is KetraTerm's stable internal model. External formats, including Fig-style specs, should be imported into this representation instead of being exposed to UI modules.

Throws

IllegalArgumentException

if name or any alias is blank.

Constructors

TerminalCommandSpec

@JvmOverloads

constructor(name: String, description: String = "", aliases: List<String> = emptyList(), subcommands: List<TerminalCommandSpec> = emptyList(), options: List<TerminalOptionSpec> = emptyList(), positionalArguments: List<TerminalArgumentSpec> = emptyList(), positionalArgumentPathKind: TerminalPathArgumentKind = TerminalPathArgumentKind.NONE, positionalArgumentValueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, positionalArgumentHiddenPathPolicy: TerminalHiddenPathPolicy = TerminalHiddenPathPolicy.DEFAULT, repeatableSubcommands: Boolean = false)

Properties

aliases

val aliases: List<String>

additional tokens that resolve to this command.

description

val description: String

short human-readable description.

name

val name: String

canonical command or subcommand token.

options

val options: List<TerminalOptionSpec>

options available at this command level.

positionalArgumentHiddenPathPolicy

val positionalArgumentHiddenPathPolicy: TerminalHiddenPathPolicy

hidden-entry policy used when positionalArgumentPathKind accepts a path.

positionalArgumentPathKind

val positionalArgumentPathKind: TerminalPathArgumentKind

file-system path kind accepted by bare positional arguments after this command or subcommand.

positionalArguments

val positionalArguments: List<TerminalArgumentSpec>

ordered positional argument declarations. When nonempty, they take precedence over the scalar positional metadata.

positionalArgumentValueDomain

val positionalArgumentValueDomain: TerminalCompletionValueDomain

dynamic host-owned value domain accepted by bare positional arguments after this command or subcommand.

repeatableSubcommands

val repeatableSubcommands: Boolean

whether multiple child subcommand tokens may appear as sibling positional command values. This models task-style CLIs such as Gradle, where gradle clean build is a sequence of tasks rather than build being nested below clean.

subcommands

val subcommands: List<TerminalCommandSpec>

nested subcommands available after this command.