Skip to content
v0.1.3

Audit Module API Reference

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

bijux_cli.contracts.audit

Defines the contract for the audit logging and diagnostics service.

This module specifies the AuditProtocol, a formal interface that any auditing service within the application must implement. This ensures a consistent API for logging command executions and performing system health checks, promoting modularity and testability.

AuditProtocol

Bases: ProcessPoolProtocol, Protocol

Defines the contract for audit logging and system diagnostics.

This interface specifies the methods required for securely logging command executions, retrieving audit trails, and performing diagnostic checks on the CLI environment. It inherits from ProcessPoolProtocol to manage command execution.

cli_audit 

cli_audit() -> None

Performs a CLI-specific audit and status check.

This method is the entry point for the bijux audit command. Implementations should gather and log the current audit status without raising exceptions or executing external commands.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/audit.py 
56
57
58
59
60
61
62
63
64
65
66
def cli_audit(self) -> None:
    """Performs a CLI-specific audit and status check.

    This method is the entry point for the `bijux audit` command.
    Implementations should gather and log the current audit status without
    raising exceptions or executing external commands.

    Returns:
        None:
    """
    ...

get_commands 

get_commands() -> list[dict[str, Any]]

Returns a copy of all recorded audit commands.

Returns:

  • list[dict[str, Any]] –

    list[dict[str, Any]]: A list of dictionaries, where each dictionary represents a logged command execution.

Source code in src/bijux_cli/contracts/audit.py 
47
48
49
50
51
52
53
54
def get_commands(self) -> list[dict[str, Any]]:
    """Returns a copy of all recorded audit commands.

    Returns:
        list[dict[str, Any]]: A list of dictionaries, where each dictionary
            represents a logged command execution.
    """
    ...

log 

log(cmd: list[str], *, executor: str) -> None

Logs a command execution for auditing purposes.

Parameters:

  • cmd (list[str]) –

    The command and its arguments to log.

  • executor (str) –

    The name or identifier of the entity that executed the command.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/audit.py 
34
35
36
37
38
39
40
41
42
43
44
45
def log(self, cmd: list[str], *, executor: str) -> None:
    """Logs a command execution for auditing purposes.

    Args:
        cmd (list[str]): The command and its arguments to log.
        executor (str): The name or identifier of the entity that executed
            the command.

    Returns:
        None:
    """
    ...