system · Command reference

`qzx getDiskSpace`

What it does

Gets information about disk space usage

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

Works without invoking native programs

Works without network access

No elevation required by design

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

Exact syntax

qzx getDiskSpace [path] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
path	str	No	Not declared	Path to get disk information from. If not provided, all disks will be shown

Input examples

qzx getDiskSpace

Get information about all available disks

qzx getDiskSpace C:

Get information about the C: drive (Windows)

qzx getDiskSpace /home

Get information about the /home partition (Linux/Mac)

For the complete structured payload, add --json: qzx getDiskSpace [path] --json

Observed output example

Captured with QZX 0.2.2.0.9 on Windows 11; exit code 0. Host-dependent values and duration can vary.

Example command: qzx getDiskSpace . --json

{
    "success": true,
    "message": "Disk information for '.': 3.34 TB used of 3.38 TB total (98.7% used), 44.99 GB free.",
    "disk_info": {
        "path": ".",
        "total_bytes": 3718889074688,
        "used_bytes": 3670577057792,
        "free_bytes": 48312016896,
        "total": "3.38 TB",
        "used": "3.34 TB",
        "free": "44.99 GB",
        "percent": 98.7
    },
    "meta": {
        "command": "getDiskSpace",
        "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": 3.378,
        "schema_version": 1
    }
}

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
        },
        "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.

{
    "success": false,
    "error": "Path '../artifacts/qzx-evidence/missing-golden-core-path' does not exist",
    "message": "Failed to get disk information: Path '../artifacts/qzx-evidence/missing-golden-core-path' does not exist.",
    "meta": {
        "command": "getDiskSpace",
        "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": 2.952,
        "schema_version": 1
    }
}

Captured command: qzx getDiskSpace ../artifacts/qzx-evidence/missing-golden-core-path --json

Evidence workflow: captured and digest-validated.

Evidence and provenance

Implementation: src/qzx/commands/system/get_disk_space.py
Tests: tests/test_system_commands/test_get_disk_space.py
Documentation channel: Development documentation 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Availability: 0.2.2.0.9 or earlier

Practical guide

Learn when qzx getDiskSpace fits the task, how native operating-system tools compare, and which details matter in automation.

13 min read
How to check disk space on Windows, Linux, and macOS
Windows, Linux, and macOS expose disk capacity differently. Learn the native commands, what their numbers mean, and how QZX provides one structured cross-platform request.
Read the practical guide

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