aiq.cli.commands.start#

Attributes#

logger

Classes#

StartCommandGroup

A multi command is the basic implementation of a command that

Functions#

start_command(→ None)

Run an AgentIQ workflow using a front end configuration.

Module Contents#

logger#
class StartCommandGroup(
name: str | None = None,
invoke_without_command: bool = False,
no_args_is_help: bool | None = None,
subcommand_metavar: str | None = None,
chain: bool = False,
result_callback: collections.abc.Callable[Ellipsis, Any] | None = None,
**attrs: Any,
)#

Bases: click.MultiCommand

A multi command is the basic implementation of a command that dispatches to subcommands. The most common version is the Group.

Parameters:

  • invoke_without_command – this controls how the multi command itself is invoked. By default it’s only invoked if a subcommand is provided.

  • no_args_is_help – this controls what happens if no arguments are provided. This option is enabled by default if invoke_without_command is disabled or disabled if it’s enabled. If enabled this will add --help as argument if no arguments are passed.

  • subcommand_metavar – the string that is used in the documentation to indicate the subcommand place.

  • chain – if this is set to True chaining of multiple subcommands is enabled. This restricts the form of commands in that they cannot have optional arguments but it allows multiple commands to be chained together.

  • result_callback – The result callback to attach to this multi command. This can be set or changed later with the result_callback() decorator.

  • attrs – Other command arguments described in Command.

_commands: dict[str, click.Command] | None = None#
_registered_front_ends: dict[str, aiq.cli.type_registry.RegisteredFrontEndInfo]#
_build_params(
front_end: aiq.cli.type_registry.RegisteredFrontEndInfo,
) → list[click.Parameter]#
_load_commands() → dict[str, click.Command]#
invoke_subcommand(
ctx: click.Context,
cmd_name: str,
config_file: pathlib.Path,
override: tuple[tuple[str, str], Ellipsis],
**kwargs,
) → int | None#
get_command(ctx: click.Context, cmd_name: str) → click.Command | None#

Given a context and a command name, this returns a Command object if it exists or returns None.

list_commands(ctx: click.Context) → list[str]#

Returns a list of subcommand names in the order they should appear.

start_command(ctx: click.Context, **kwargs) → None#

Run an AgentIQ workflow using a front end configuration.