Skip to content

CausalIQ Analysis CLI

The command-line interface provides commands for analysing and visualising learned causal graphs, including structural metrics, stability assessment, significance tests, and publication-ready tables and charts.

Each command is a click command implemented in its own module under causaliq_analysis.cli.commands. cli/commands/__init__.py lists the command objects in COMMANDS and registers them on the group, so adding a command means adding one module plus one registry entry.

Entry point

cli

Command-line interface for causaliq-analysis.

Modules:

  • commands –

    Command registry for the causaliq-analysis CLI.

  • common –

    Shared helpers for the causaliq-analysis command-line interface.

Functions:

  • cli –

    CausalIQ Analysis CLI - Tools for analysing and visualising causal graphs.

  • main –

    Entry point for the CLI.

  • register_commands –

    Register every command on the CLI group.

cli

cli() -> None

CausalIQ Analysis CLI - Tools for analysing and visualising causal graphs.

main

main() -> None

Entry point for the CLI.

register_commands

register_commands(group: Group) -> None

Register every command on the CLI group.

Parameters:

  • group
    (Group) –

    Click group to register the commands on.

Command registry

commands

Command registry for the causaliq-analysis CLI.

Each command lives in its own module in this sub-package. COMMANDS lists the command objects in registration order and register_commands adds them to the click group, so adding a command means adding one module plus one entry here.

Modules:

Functions:

register_commands

register_commands(group: Group) -> None

Register every command on the CLI group.

Parameters:

  • group
    (Group) –

    Click group to register the commands on.

Commands

Shared helpers

causaliq_analysis.cli.common holds the internal metadata flattening, nested-value lookup and summary-table helpers shared by the command modules. They are implementation details; the public API is the click group and the commands listed above.