qzx getDiskInfo

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 getDiskInfo --json

{
    "success": true,
    "message": "Gets information about disk space usage. In this illustrative example, the command completed successfully.",
    "disk_info": {
        "path": "C:\\project",
        "total_bytes": 1000204886016,
        "free_bytes": 472446402560,
        "percent_used": 52.8
    },
    "disks": [
        {
            "name": "C:",
            "total_space_readable": "931.51 GiB",
            "free_space_readable": "440.00 GiB",
            "percent_used": 52.8
        }
    ],
    "summary": {
        "status": "healthy",
        "items_checked": 4
    }
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "disk_info": [],
        "disks": [],
        "error": {
            "type": "string"
        },
        "summary": {
            "type": "object",
            "properties": {
                "total_disks": [],
                "total_space": [],
                "total_space_readable": [],
                "used_space": [],
                "used_space_readable": [],
                "free_space": [],
                "free_space_readable": [],
                "percent_used": []
            },
            "additionalProperties": true
        }
    },
    "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: ready for deterministic automated capture.