Argument

Less than 1 minute

Immutable descriptor for a positional console command argument.

class Argument

Defines argument metadata used by command parsers, including display name, optional description text, and whether the argument is mandatory.

Properties

argument identifier used in CLI definitions

public string $name

Type: string

optional human-readable argument description

public string $description

Type: string

whether the argument must be provided by the caller

public bool $required

Type: bool

Creates a command argument descriptor.

public __construct(string $name, string $description, bool $required): void

Parameter	Type	Description
`$name`	string	argument identifier used in CLI definitions
`$description`	string	optional human-readable argument description
`$required`	bool	whether the argument must be provided by the caller

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:18 +0000