system · Command reference

qzx systemDoctor

What it does

Performs a complete diagnostic of the CPU, RAM, disks, network, PATH, services, ports, and system errors

Canonical command: systemDoctor

Accepted aliases: None

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

May invoke native programs

May use the network

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:d5b475635c20e348e2f71b385047a5545fd3abaebc532a521c4498bfa29e70c9 on 2026-07-25.

Exact syntax

qzx systemDoctor [quick] --json

Parameters

NameTypeRequiredDefaultDescription
quickboolNofalseIf True, perform only a quick essential system check (default: False)

Input examples

qzx systemDoctor

Run full system diagnostic

qzx systemDoctor --quick True

Run quick essential check

For the complete structured payload, add --json: qzx systemDoctor [quick] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx systemDoctor --json

{
    "success": true,
    "message": "Performs a complete diagnostic of the CPU, RAM, disks, network, PATH, services, ports, and system errors. In this illustrative example, the command completed successfully.",
    "details": {
        "summary": "Additional structured context is included here."
    }
}
View the JSON result contract
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "details": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires an authorized endpoint or reviewed fixture.

Evidence and provenance

Documentation channel
Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability
0.2.2.0.2 or earlier

Keep exploring

These commands also belong to the system category. Compare them to choose the operation that best fits your task.

Explore all QZX commands