Struct CommandDefinition 

pub struct CommandDefinition {
    pub name: String,
    pub aliases: Vec<String>,
    pub description: String,
    pub required: bool,
    pub arguments: Vec<ArgumentDefinition>,
    pub options: Vec<OptionDefinition>,
    pub implementation: String,
    pub continue_on_failure: bool,
    pub requires_success: bool,
}

Definition of a single command

Describes a command with its arguments, options, and validation rules. Each command must have a corresponding handler implementation.

Example

name: simulate
aliases: [sim, run]
description: "Run a simulation"
required: true
arguments:
  - name: input_file
    arg_type: path
    required: true
    description: "Input configuration file"
    validation:
      - must_exist: true
      - extensions: [yaml, json]
options: []
implementation: "simulate_handler"
continue_on_failure: false
requires_success: false

Fields

name: String

Command name (used for invocation)

aliases: Vec<String>

Alternative names for the command

description: String

Human-readable description for help text

required: bool

Whether this command is required to be implemented

If true, the application will fail to start if no handler is registered.

arguments: Vec<ArgumentDefinition>

Positional arguments

options: Vec<OptionDefinition>

Named options (flags)

implementation: String

Name of the handler implementation

This string is used to match the command with its registered handler in the CommandRegistry.

continue_on_failure: bool

Whether the chain continues when this command fails (DD-026).

Governs the chain’s behaviour when this command is one segment of a multi-command CLI invocation (or a chained run_script() line) and its handler returns an error:

• false (default): stop-on-first-error — identical to today’s single-command exit behaviour, just applied per segment.
• true: the chain-position error is reported but execution proceeds to the next segment. Intended for genuinely optional steps (e.g. a non-critical secondary export).

Has no effect outside a chain (a single, non-chained command behaves exactly as it does today regardless of this value).

requires_success: bool

Whether this command requires every earlier command in the chain to have succeeded before it is allowed to run (DD-026).

Not to be confused with Self::required, which is an unrelated, startup-time check (“a handler must be registered for this command”) — requires_success is a per-invocation, chain-position concern evaluated at dispatch time, and only observable downstream of an earlier command whose own continue_on_failure is true (otherwise the chain has already stopped by the time this command would run).

• false (default): runs regardless of any earlier failure in the chain (moot under the default stop-on-first policy).
• true: if any earlier command in the chain has already failed (tracked via a running chain_has_failure flag, regardless of that failure’s own continue_on_failure value), this command is skipped — not executed, not counted as an additional failure — and reported distinctly from a chain-position error.

Trait Implementations

impl Clone for CommandDefinition

fn clone(&self) -> CommandDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandDefinition

fn eq(&self, other: &CommandDefinition) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CommandDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandDefinition