doFolder.cli.main module

Main CLI entry point for the doFolder package.

This module provides the unified command-line interface that routes to various subcommand implementations.

doFolder.cli.main.SUBCOMMANDS = {'compare': <function compareCli>, 'hash': <function hashCli>}

Dictionary mapping subcommand names to their corresponding CLI functions

doFolder.cli.main.mainCli(arguments: Sequence[str] | None = None, prog='buildDoc.py') → int

The unified entry point for the doFolder CLI application.

This function serves as the main dispatcher for all doFolder subcommands. It parses the command line arguments and routes execution to the appropriate subcommand handler.

Returns:

Exit code from the executed subcommand (0 for success, non-zero for failure).

Return type:

int

Raises:

SystemExit – When an unknown subcommand is provided or parsing fails.

Example

This function is typically called when users run: - do-folder compare path1 path2 - python -m doFolder compare path1 path2