Functions

List of functions in the ude.cli namespace.

Entity Name	Description
run_pipeline	Executes the complete documentation compilation pipeline based on merged configurations.
_run_pipeline_from_flags	Shared argument-extraction and delegation path for `compile` and the legacy flat-flag entry point. Both parse the identical set of CLI flags and forward them to run_pipeline() unchanged; they differ only in the error message emitted when –doc-config is absent, which is why IMP-01.7 (byte-identical output) holds between them (see test_compile_and_flat_flags_output_identical).
_handle_compile	Handles the compile subcommand, delegating directly to run_pipeline.
_handle_parse	Parse only: executes parsing on orchestrator and writes IR to –output-ir path.
_handle_render	Render only: loads Intermediate Representation from –input-ir and renders it.
_handle_audit	Handles the audit subcommand: parses the target and enforces the documentation coverage gate, printing the coverage table to stdout.
_handle_flat_flags	Fallback handler for backward-compatibility with v1.0 flat CLI flags.
_handle_diff
_add_compile_subparser	Registers the ‘compile’ subparser and its argument flags.
_add_parse_subparser	Registers the ‘parse’ subparser and its argument flags.
_add_render_subparser	Registers the ‘render’ subparser and its argument flags.
_add_audit_subparser	Registers the ‘audit’ subparser and its argument flags.
_add_diff_subparser	Registers the ‘diff’ subparser and its argument flags.
main	Primary entry point for the command-line interface.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

_add_audit_subparser function

Registers the ‘audit’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Methods

_add_audit_subparser

_add_audit_subparser(subparsers: argparse._SubParsersAction)

Registers the ‘audit’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Parameter	Type	Description
subparsers	`argparse._SubParsersAction`	The parent parser’s subparsers action to register ‘audit’ under.

Generated with Flude

_add_compile_subparser function

Registers the ‘compile’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Methods

_add_compile_subparser

_add_compile_subparser(subparsers: argparse._SubParsersAction)

Registers the ‘compile’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Parameter	Type	Description
subparsers	`argparse._SubParsersAction`	The parent parser’s subparsers action to register ‘compile’ under.

Generated with Flude

_add_diff_subparser function

Registers the ‘diff’ subparser and its argument flags.

Methods

_add_diff_subparser

_add_diff_subparser(subparsers: argparse._SubParsersAction)

Registers the ‘diff’ subparser and its argument flags.

Parameter	Type	Description
subparsers	`argparse._SubParsersAction`

Generated with Flude

_add_parse_subparser function

Registers the ‘parse’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Methods

_add_parse_subparser

_add_parse_subparser(subparsers: argparse._SubParsersAction)

Registers the ‘parse’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Parameter	Type	Description
subparsers	`argparse._SubParsersAction`	The parent parser’s subparsers action to register ‘parse’ under.

Generated with Flude

_add_render_subparser function

Registers the ‘render’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Methods

_add_render_subparser

_add_render_subparser(subparsers: argparse._SubParsersAction)

Registers the ‘render’ subparser and its argument flags.

Implements GAP-01 (TASK-B.2.x): CLI subcommand registration.

Parameter	Type	Description
subparsers	`argparse._SubParsersAction`	The parent parser’s subparsers action to register ‘render’ under.

Generated with Flude

_handle_audit function

Handles the audit subcommand: parses the target and enforces the documentation coverage gate, printing the coverage table to stdout.

Implements GAP-01 (TASK-B.2.x) / GAP-10 (IMP-10.3): CLI subcommand handler.

Returns:

Exit code (see user-docs/docs/cli-reference.md):

Methods

_handle_audit

_handle_audit() -> int

Handles the audit subcommand: parses the target and enforces the documentation coverage gate, printing the coverage table to stdout.

Implements GAP-01 (TASK-B.2.x) / GAP-10 (IMP-10.3): CLI subcommand handler.

Returns:

Exit code (see user-docs/docs/cli-reference.md):

_handle_compile function

Handles the compile subcommand, delegating directly to run_pipeline.

Implements GAP-01 (TASK-B.2.x): CLI subcommand handler.

Returns:

Exit code, as returned by run_pipeline().

Methods

_handle_compile

_handle_compile() -> int

Handles the compile subcommand, delegating directly to run_pipeline.

Implements GAP-01 (TASK-B.2.x): CLI subcommand handler.

Returns:

Exit code, as returned by run_pipeline().

Parameter	Type	Description
args	`argparse.Namespace`	Parsed CLI arguments for the `compile` subcommand.

Generated with Flude

_handle_diff function

Methods

_handle_diff

_handle_diff() -> int

Parameter	Type	Description
args	`argparse.Namespace`

Generated with Flude

_handle_flat_flags function

Fallback handler for backward-compatibility with v1.0 flat CLI flags.

Returns:

Exit code, as returned by run_pipeline().

Methods

_handle_flat_flags

_handle_flat_flags() -> int

Fallback handler for backward-compatibility with v1.0 flat CLI flags.

Returns:

Exit code, as returned by run_pipeline().

Parameter	Type	Description
args	`argparse.Namespace`	Parsed CLI arguments from the top-level (subcommand-less) parser.

Generated with Flude

_handle_parse function

Parse only: executes parsing on orchestrator and writes IR to –output-ir path.

Implements GAP-01 (TASK-B.2.x): CLI subcommand handler.

Returns:

Exit code: 0 on success, 1 on missing config/unclassified error, 3 on collector error, 4 on parser error.

Methods

_handle_parse

_handle_parse() -> int

Parse only: executes parsing on orchestrator and writes IR to –output-ir path.

Implements GAP-01 (TASK-B.2.x): CLI subcommand handler.

Returns:

Exit code: 0 on success, 1 on missing config/unclassified error, 3 on collector error, 4 on parser error.

_handle_render function

Render only: loads Intermediate Representation from –input-ir and renders it.

Implements GAP-01 (TASK-B.2.x): CLI subcommand handler.

Returns:

Exit code: 0 on success, 1 on a pipeline/config error, 5 on renderer error.

Methods

_handle_render

_handle_render() -> int

Render only: loads Intermediate Representation from –input-ir and renders it.

Implements GAP-01 (TASK-B.2.x): CLI subcommand handler.

Returns:

Exit code: 0 on success, 1 on a pipeline/config error, 5 on renderer error.

Parameter	Type	Description
args	`argparse.Namespace`	Parsed CLI arguments for the `render` subcommand.

Generated with Flude

_run_pipeline_from_flags function

Shared argument-extraction and delegation path for compile and the legacy flat-flag entry point. Both parse the identical set of CLI flags and forward them to run_pipeline() unchanged; they differ only in the error message emitted when –doc-config is absent, which is why IMP-01.7 (byte-identical output) holds between them (see test_compile_and_flat_flags_output_identical).

Returns:

Exit code, as returned by run_pipeline().

Methods

_run_pipeline_from_flags

_run_pipeline_from_flags(missing_doc_config_message: str) -> int

main function

Primary entry point for the command-line interface.

Returns:

Exit code.

Methods

main

main(argv: Optional]) -> int

Primary entry point for the command-line interface.

Returns:

Exit code.

Parameter	Type	Description
argv	`Optional]`	Optional list of command-line arguments to parse. Defaults to sys.argv[1:].

Generated with Flude

run_pipeline function

Executes the complete documentation compilation pipeline based on merged configurations.

Returns:

Exit code: 0 on success, non-zero on failure.

Methods

run_pipeline

run_pipeline(global_config_path: Optional, sdk_config_path: Optional, doc_config_path: Path, input_override: Optional, output_override: Optional, format_override: Optional, max_workers_override: Optional) -> int

Executes the complete documentation compilation pipeline based on merged configurations.

Returns:

Exit code: 0 on success, non-zero on failure.

Parameter	Type	Description
global_config_path	`Optional`	Path to the global system configuration, or None to skip.
sdk_config_path	`Optional`	Path to the SDK/product metadata configuration, or None to skip.
doc_config_path	`Path`	Path to the target document configuration (e.g. ude_doc_config.json).
input_override	`Optional`	Optional override path for the source directory.
output_override	`Optional`	Optional override path for the output directory.
format_override	`Optional`	Optional override format (‘hugo_markdown’ or ‘html’).
max_workers_override	`Optional`

Generated with Flude