Skip to main content

Interface: ICliCommandDefinition

Static definition of a CLI command including its name, parameters, and execution action.

Properties​

command​

command: string

The command name.

description​

description: string

The command description.

example​

example: string

An example invocation string shown in help output.

params​

params: ICliCommandDefinitionParam[]

The params available for the command.

aliases?​

optional aliases?: string[]

Deprecated names that resolve to this command with a warning.

action​

action: (engineCore, envVars, params) => Promise<unknown>

The method to execute for the command.

Parameters​

engineCore​

IEngineCore

envVars​

IEnvironmentVariables

params​

Returns​

Promise<unknown>

requiresEngineStarted?​

optional requiresEngineStarted?: boolean

Indicates whether the engine needs to be started before executing the command.

Default​

true

requiresNodeIdentity?​

optional requiresNodeIdentity?: boolean

Indicates whether the engine needs the node identity to be set if configured to use.

Default​

true

requiresOrgIdentity?​

optional requiresOrgIdentity?: boolean

Indicates whether the engine needs the organization identity to be set.

Default​

true

singleTenantOnly?​

optional singleTenantOnly?: boolean

Indicates whether this command is only available in single-tenant mode.