Doctor Command API Reference¶

This section documents the internals of the doctor command in Bijux CLI.

bijux_cli.commands.doctor ¶

Implements the doctor command for the Bijux CLI.

This module provides the functionality for the bijux doctor command, which runs a series of health diagnostics on the CLI's operating environment. It checks for common configuration issues and reports a summary of its findings in a structured, machine-readable format suitable for automation.

Output Contract

Success: {"status": str, "summary": list[str]}
Verbose: Adds {"python": str, "platform": str} to the payload.
Error: {"error": str, "code": int}

Exit Codes

0: Success (command ran without errors, regardless of health status).
1: Internal or fatal error (e.g., dependency injection failure).
2: CLI argument or flag error.

doctor ¶

doctor(
    ctx: Context,
    quiet: bool = Option(
        False, "-q", "--quiet", help=HELP_QUIET
    ),
    verbose: bool = Option(
        False, "-v", "--verbose", help=HELP_VERBOSE
    ),
    fmt: str = Option(
        "json", "-f", "--format", help=HELP_FORMAT
    ),
    pretty: bool = Option(
        True, "--pretty/--no-pretty", help=HELP_NO_PRETTY
    ),
    debug: bool = Option(
        False, "-d", "--debug", help=HELP_DEBUG
    ),
) -> None

Defines the entrypoint and logic for the bijux doctor command.

This function orchestrates the health check process. It validates all CLI flags, performs critical pre-flight checks (like dependency availability), and then invokes the main run utility to build and emit the health payload.

Parameters:

ctx (Context) –

The Typer context for managing command state.
quiet (bool, default: Option(False, '-q', '--quiet', help=HELP_QUIET) ) –

If True, suppresses all output; the exit code is the primary indicator of the outcome.
verbose (bool, default: Option(False, '-v', '--verbose', help=HELP_VERBOSE) ) –

If True, includes Python and platform details in the output payload.
fmt (str, default: Option('json', '-f', '--format', help=HELP_FORMAT) ) –

The output format, either "json" or "yaml". Defaults to "json".
pretty (bool, default: Option(True, '--pretty/--no-pretty', help=HELP_NO_PRETTY) ) –

If True, pretty-prints the output for human readability.
debug (bool, default: Option(False, '-d', '--debug', help=HELP_DEBUG) ) –

If True, enables debug diagnostics, implying verbose and pretty.

Returns:

None ( None ) –

Raises:

SystemExit –

Exits the application with a contract-compliant status code and payload upon any error, such as invalid arguments or an internal system failure.

Source code in src/bijux_cli/commands/doctor.py

@doctor_app.callback(invoke_without_command=True)
def doctor(
    ctx: typer.Context,
    quiet: bool = typer.Option(False, "-q", "--quiet", help=HELP_QUIET),
    verbose: bool = typer.Option(False, "-v", "--verbose", help=HELP_VERBOSE),
    fmt: str = typer.Option("json", "-f", "--format", help=HELP_FORMAT),
    pretty: bool = typer.Option(True, "--pretty/--no-pretty", help=HELP_NO_PRETTY),
    debug: bool = typer.Option(False, "-d", "--debug", help=HELP_DEBUG),
) -> None:
    """Defines the entrypoint and logic for the `bijux doctor` command.

    This function orchestrates the health check process. It validates all CLI
    flags, performs critical pre-flight checks (like dependency availability),
    and then invokes the main run utility to build and emit the health payload.

    Args:
        ctx (typer.Context): The Typer context for managing command state.
        quiet (bool): If True, suppresses all output; the exit code is the
            primary indicator of the outcome.
        verbose (bool): If True, includes Python and platform details in the
            output payload.
        fmt (str): The output format, either "json" or "yaml". Defaults to "json".
        pretty (bool): If True, pretty-prints the output for human readability.
        debug (bool): If True, enables debug diagnostics, implying `verbose`
            and `pretty`.

    Returns:
        None:

    Raises:
        SystemExit: Exits the application with a contract-compliant status code
            and payload upon any error, such as invalid arguments or an
            internal system failure.
    """
    if ctx.invoked_subcommand:
        return

    command = "doctor"

    fmt_lower = validate_common_flags(fmt, command, quiet)

    if ctx.args:
        stray = ctx.args[0]
        msg = (
            f"No such option: {stray}"
            if stray.startswith("-")
            else f"Too many arguments: {' '.join(ctx.args)}"
        )
        emit_error_and_exit(
            msg,
            code=2,
            failure="args",
            command=command,
            fmt=fmt_lower,
            quiet=quiet,
            include_runtime=verbose,
            debug=debug,
        )

    try:
        DIContainer.current().resolve(EmitterProtocol)
        DIContainer.current().resolve(TelemetryProtocol)
    except Exception as exc:
        emit_error_and_exit(
            str(exc),
            code=1,
            failure="internal",
            command=command,
            fmt=fmt_lower,
            quiet=quiet,
            include_runtime=verbose,
            debug=debug,
        )

    new_run_command(
        command_name=command,
        payload_builder=_build_payload,
        quiet=quiet,
        verbose=verbose,
        fmt=fmt_lower,
        pretty=pretty,
        debug=debug,
    )