hbllmutils.entry.cli

Command-line interface entry point for hbllmutils package.

This module serves as the main CLI entry point for the hbllmutils package, providing a unified command-line interface by composing various subcommands through a decorator pattern. It aggregates functionality from different modules to create a comprehensive CLI tool.

The module contains the following main components:

• cli - Main CLI group that serves as the entry point for all commands

Note

This module uses a decorator pattern to dynamically add subcommands to the main CLI group. New subcommands can be added by including their decorators in the _DECORATORS list.

Example:

>>> # The CLI can be invoked from the command line:
>>> # $ hbllmutils code pydoc --help
>>> # $ hbllmutils code todo --help
>>> 
>>> # Or programmatically:
>>> from hbllmutils.entry.cli import cli
>>> cli()

cli

hbllmutils.entry.cli.cli = <Group hbllmutils>

Main CLI group entry point for hbllmutils command-line interface.

This function serves as the primary command group for the hbllmutils CLI application. It provides the foundation for all subcommands and handles global options such as version display and help information.

The function is decorated with Click’s group decorator to enable command grouping functionality, allowing subcommands to be registered and executed under the main hbllmutils command.

Returns:

None - serves as a command group container

Return type:

None

Note

This function acts as a command group container and does not perform any operations directly. Actual functionality is provided by subcommands registered to this group.

Note

Global options like --version and --help are available at this level and apply to the entire CLI application.

Example:

>>> # Display help information
>>> # $ hbllmutils --help
>>> # Usage: hbllmutils [OPTIONS] COMMAND [ARGS]...
>>> #
>>> # A Python utility library for streamlined Large Language Model
>>> # interactions with unified API and conversation management.
>>> #
>>> # Options:
>>> #   -v, --version  Show hbllmutils's version information.
>>> #   -h, --help     Show this message and exit.

cli

hbllmutils.entry.cli.cli = <Group hbllmutils>

Main CLI group entry point for hbllmutils command-line interface.

This function serves as the primary command group for the hbllmutils CLI application. It provides the foundation for all subcommands and handles global options such as version display and help information.

The function is decorated with Click’s group decorator to enable command grouping functionality, allowing subcommands to be registered and executed under the main hbllmutils command.

Returns:

None - serves as a command group container

Return type:

None

Note

This function acts as a command group container and does not perform any operations directly. Actual functionality is provided by subcommands registered to this group.

Note

Global options like --version and --help are available at this level and apply to the entire CLI application.

Example:

>>> # Display help information
>>> # $ hbllmutils --help
>>> # Usage: hbllmutils [OPTIONS] COMMAND [ARGS]...
>>> #
>>> # A Python utility library for streamlined Large Language Model
>>> # interactions with unified API and conversation management.
>>> #
>>> # Options:
>>> #   -v, --version  Show hbllmutils's version information.
>>> #   -h, --help     Show this message and exit.