orionis.console.fluent.contracts.command.ICommand

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class ICommand(ABC): (source)

Undocumented

Method	`arguments`	Set CLI arguments for the command.
Method	`description`	Set description for the command.
Method	`get`	Retrieve configured Command entity.
Method	`timestamp`	Configure timestamp display for command output.

def arguments(self, args: list) -> ICommand: (source) ¶

overridden in orionis.console.fluent.Command

Set CLI arguments for the command.

Configure accepted command-line arguments.

Parameters
args:`list`	List of Argument instances.

Returns
`Command`	Returns self for method chaining.

Raises
`TypeError`	If args is not a list or contains non-Argument elements.

def description(self, desc: str) -> ICommand: (source) ¶

overridden in orionis.console.fluent.Command

Set description for the command.

Assign a descriptive text for help and documentation.

Parameters
desc:`str`	Description text for the command.

Returns
`Command`	Returns self for method chaining.

Raises
`TypeError`	If desc is not a string.

def get(self) -> tuple[str, CommandEntity]: (source) ¶

overridden in orionis.console.fluent.Command

Retrieve configured Command entity.

Construct and return CommandEntity with all configuration.

Returns
`tuple of (str, CommandEntity)`	Command signature and CommandEntity instance.

def timestamp(self, *, enabled: bool = True) -> ICommand: (source) ¶

overridden in orionis.console.fluent.Command

Configure timestamp display for command output.

Enable or disable timestamps in command results.

Parameters
enabled:`bool, default True`	Enable or disable timestamp display.

Returns
`Command`	Returns self for method chaining.

Raises
`TypeError`	If enabled is not a boolean.