Skip to content
v0.1.3

Doctor Module API Reference

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

bijux_cli.contracts.doctor

Defines the contract for the CLI health check and diagnostics service.

This module specifies the DoctorProtocol, a formal interface that any service responsible for running diagnostic health checks on the CLI and its environment must implement.

DoctorProtocol

Bases: Protocol

Defines the contract for CLI health checks.

This interface specifies the methods for performing system health checks and gathering diagnostic information about the CLI and its environment.

check_health 

check_health() -> str

Performs health checks and returns a status string.

Returns:

  • str ( str ) –

    A string describing the overall health status of the CLI.

Source code in src/bijux_cli/contracts/doctor.py 
26
27
28
29
30
31
32
def check_health(self) -> str:
    """Performs health checks and returns a status string.

    Returns:
        str: A string describing the overall health status of the CLI.
    """
    ...