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.6a11. This page documents the 0.2.2.0.6a11 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

This safety classification was reviewed by OpenAI Codex (authorized project audit) against implementation digest sha256:0581fa335886270f72ba66dc101bc665036a1c753eded229dc2f6b2c3f23f7bc on 2026-07-30.

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

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

{
    "success": true,
    "message": "Gets information about disk space usage. In this illustrative example, the command completed successfully.",
    "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": 0,
        "schema_version": 1
    },
    "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
    }
}

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.

Evidence workflow: ready for deterministic automated capture.

Evidence and provenance

Implementation: src/qzx/commands/system/get_disk_space.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.6a11 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Availability: 0.2.2.0.6a11 or earlier

Practical guide

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

10 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