system · Command reference

`qzx listDiskDevices`

What it does

Gets disk name/model information for a disk or all disks

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.9. This page documents the 0.2.2.0.9 alpha development checkout.

Behavior and built-in protections

Inspects without changing state

Direct execution for this operation

Uses a native tool when needed

Works without network access

No elevation required by design

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:7d07e05b84ef4206f64f20977ad20e9e603c30ce3b355e8c4b27a4c6f523ebf7 on 2026-08-25.

Exact syntax

qzx listDiskDevices [disk_path] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
disk_path	str	No	Not declared	Path to the disk to get information for. If not provided, shows information for all disks

Input examples

qzx listDiskDevices

Get information about all disks

qzx listDiskDevices C:

Get information about the C: drive (Windows)

qzx listDiskDevices /dev/sda

Get information about the /dev/sda disk (Linux)

For the complete structured payload, add --json: qzx listDiskDevices [disk_path] --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 listDiskDevices --json

{
    "success": true,
    "message": "Gets disk name/model information for a disk or all disks. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "listDiskDevices",
        "command_maturity": {
            "stage": "alpha",
            "label": "Alpha",
            "sequence": 2,
            "public_executable": true,
            "stability": "interface_may_change",
            "summary": "Available for real use and feedback while its interface and behavior can still evolve.",
            "promotion_review_required": false,
            "assessment_scope": "development_checkout"
        },
        "duration_ms": 0,
        "schema_version": 1
    },
    "block_devices": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "block_devices_error": "Example value",
    "block_devices_raw": "Example value",
    "details": {
        "disk_path": "C:\\project\\example.txt"
    },
    "disk_list": "Example value",
    "disk_list_error": "Example value",
    "disk_list_raw": "Example value",
    "disks": [
        {
            "name": "C:",
            "total_space_readable": "931.51 GiB",
            "free_space_readable": "440.00 GiB",
            "percent_used": 52.8
        }
    ],
    "os_type": "Windows",
    "physical_disks": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "physical_disks_error": "Example value"
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "meta": {
            "type": "object",
            "required": [
                "command",
                "command_maturity",
                "duration_ms",
                "schema_version"
            ],
            "properties": {
                "command": {
                    "type": "string"
                },
                "command_maturity": {
                    "type": "object",
                    "required": [
                        "stage",
                        "label",
                        "sequence",
                        "public_executable",
                        "stability",
                        "summary",
                        "promotion_review_required",
                        "assessment_scope"
                    ],
                    "properties": {
                        "stage": {
                            "type": "string"
                        },
                        "label": {
                            "type": "string"
                        },
                        "sequence": {
                            "type": "integer"
                        },
                        "public_executable": {
                            "type": "boolean"
                        },
                        "stability": {
                            "type": "string"
                        },
                        "summary": {
                            "type": "string"
                        },
                        "promotion_review_required": {
                            "type": "boolean"
                        },
                        "assessment_scope": {
                            "type": "string"
                        },
                        "note": {
                            "type": "string"
                        },
                        "review": {
                            "type": "object",
                            "required": [
                                "reviewed_on",
                                "rationale",
                                "evidence"
                            ],
                            "properties": {
                                "reviewed_on": {
                                    "type": "string",
                                    "format": "date"
                                },
                                "rationale": {
                                    "type": "string"
                                },
                                "evidence": {
                                    "type": "array",
                                    "minItems": 1,
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "replacement": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": true
                },
                "duration_ms": {
                    "type": "number"
                },
                "schema_version": {
                    "type": "integer"
                }
            },
            "additionalProperties": true
        },
        "block_devices": [],
        "block_devices_error": [],
        "block_devices_raw": [],
        "details": {
            "type": "object",
            "properties": {
                "disk_path": []
            },
            "additionalProperties": true
        },
        "disk_list": [],
        "disk_list_error": [],
        "disk_list_raw": [],
        "disks": {
            "type": "array"
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "os_type": [],
        "physical_disks": {
            "type": "array"
        },
        "physical_disks_error": []
    },
    "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 the supported operating-system matrix.

Evidence and provenance

Implementation: src/qzx/commands/system/list_disk_devices.py
Tests: No command-specific test file with the same module name was found; this does not prove that all coverage is absent.
Documentation channel: Development documentation 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Availability: 0.2.2.0.9 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