CLI Module

Source: gitlab_overviewer.cli.__init__.py

Command-line interface for gitlab_overviewer (Typer-based).

Implements Specification: Configuration Settings Layer §1-3 for CLI argument handling and configuration.

Provides commands for running the overview pipeline, diagnostics, and other utilities. See cli.diag and cli.__main__ for argument parsing and entry points.

cli.diag

Source: gitlab_overviewer.cli.diag.py

Diagnostic utilities for settings and configuration.

Implements Specification: Configuration Settings Layer §2-3, covering:

• Settings validation (§2)

• Diagnostic output (§3)

gitlab_overviewer.cli.diag.run_script(script_path)

Run a diagnostic script and return True if successful.

Return type:

bool

gitlab_overviewer.cli.diag.main()

Run all diagnostic scripts in sequence.

Return type:

int

cli.main

Source: gitlab_overviewer.cli.__main__.py

GitLab Overviewer main entry point.

Implements multiple specifications:

• Specification: Markdown Overview Renderer §1-4 for markdown output

• Specification: Quarto Renderer (index.qmd + project sheets) §1-4 for quarto output

• Specification: Table Sorting §1-2 for sort key handling

• Specification: Table Rendering & UI §1-3 for table configuration

• Specification: Configuration Settings Layer §1-3 for CLI argument handling

class gitlab_overviewer.cli.__main__.OutputFormat(value)

Bases: str, Enum

markdown = 'markdown'

quarto = 'quarto'

gitlab_overviewer.cli.__main__._common(ctx, sort=None, table_config='table_config.yaml', log_level='INFO', output=OutputFormat.markdown, debug=False, display_shared=False, gitlab_host=None, group_api_key=None)

Store common CLI params into context object.

gitlab_overviewer.cli.__main__.run(ctx)

Run the overview pipeline with the provided options.

gitlab_overviewer.cli.__main__.overview(ctx)

Collect and sort overview data using new pipeline.