pyfcstm.entry.cli

Command-line interface assembly for the PyFCSTM entry points.

This module composes the top-level CLI command group by applying a sequence of subcommand decorators. It exposes a ready-to-use Click group that includes the available subcommands registered by pyfcstm.entry.generate, pyfcstm.entry.plantuml, and pyfcstm.entry.simulate.

The module contains the following main component:

  • cli - Preconfigured Click command group with registered subcommands

Example:

>>> from pyfcstm.entry.cli import cli
>>> # ``cli`` is a click.Group and can be invoked by Click's command runner.
>>> isinstance(cli.name, str)
True

Note

Subcommands are added by decorator functions that mutate the Click group in place and return it for chaining.

cli

pyfcstm.entry.cli.cli: Group = <Group pyfcstmcli>

Main Click command group for the pyfcstm CLI.

This command group provides a common entry point for subcommands and integrates global options such as --version and help flags.

Returns:

None.

Return type:

None

Example:

>>> # Typically invoked via a console entry point:
>>> # $ pyfcstm --help

cli

pyfcstm.entry.cli.cli: Group = <Group pyfcstmcli>

Main Click command group for the pyfcstm CLI.

This command group provides a common entry point for subcommands and integrates global options such as --version and help flags.

Returns:

None.

Return type:

None

Example:

>>> # Typically invoked via a console entry point:
>>> # $ pyfcstm --help