Skip to content

symfonic.diagnostics.cli

cli

Typer command implementation for symfonic doctor (v7.16, item 5).

Separated from :mod:symfonic.agent.cli.main so the CLI module can stay small and so the command surface can be unit-tested in isolation via a CliRunner against a focused sub-app.

Behaviour:

  • Optional PROJECT_PATH positional argument -- when present, the command prepends it to sys.path and tries to import the scaffold convention from app.setup.agent import build_agent. When absent, a default :class:SymfonicAgent is constructed with a :class:MockModelProvider so the env-var checks (embedding, postgres) and the agent-config checks still run.
  • --strict promotes WARN findings to exit code 2 (mypy-style).
  • --no-network forces network-sensitive checks to skip; the default honours CI=true.
  • --json emits a single JSON document on stdout and suppresses the human-readable progress lines on stderr.

doctor 

doctor(
    project_path: Annotated[
        Path | None,
        Argument(
            help="Adopter project root containing ``app/setup/agent.py``. When omitted, a default in-memory agent is constructed -- env-var checks still run."
        ),
    ] = None,
    strict: Annotated[
        bool,
        Option(
            "--strict",
            help="Promote WARN findings to exit code 2.",
        ),
    ] = False,
    no_network: Annotated[
        bool | None,
        Option(
            "--no-network/--network",
            help="Skip network-sensitive checks (POSTGRES_DSN probe). Default honours CI=true in the environment.",
        ),
    ] = None,
    json_output: Annotated[
        bool,
        Option(
            "--json",
            help="Emit a single JSON document on stdout instead of the human-readable report.  Suppresses all stderr progress.",
        ),
    ] = False,
) -> None

Audit the current symfonic configuration for the v7.16 silent-fail traps.

Source code in src/symfonic/diagnostics/cli.py 
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def doctor(
    project_path: Annotated[
        Path | None,
        typer.Argument(
            help="Adopter project root containing ``app/setup/agent.py``. "
            "When omitted, a default in-memory agent is constructed -- "
            "env-var checks still run.",
        ),
    ] = None,
    strict: Annotated[
        bool,
        typer.Option(
            "--strict",
            help="Promote WARN findings to exit code 2.",
        ),
    ] = False,
    no_network: Annotated[
        bool | None,
        typer.Option(
            "--no-network/--network",
            help=(
                "Skip network-sensitive checks (POSTGRES_DSN probe). "
                "Default honours CI=true in the environment."
            ),
        ),
    ] = None,
    json_output: Annotated[
        bool,
        typer.Option(
            "--json",
            help=(
                "Emit a single JSON document on stdout instead of the "
                "human-readable report.  Suppresses all stderr progress."
            ),
        ),
    ] = False,
) -> None:
    """Audit the current symfonic configuration for the v7.16 silent-fail traps."""
    agent = _load_agent(project_path, suppress_stderr=json_output)
    effective_no_network = resolve_no_network(explicit_flag=no_network)
    report = audit_hms_sync(agent, no_network=effective_no_network)

    if json_output:
        typer.echo(json.dumps(report.to_json_dict(strict=strict), indent=2))
    else:
        _render_human(report)

    raise SystemExit(report.exit_code(strict=strict))