Skip to main content

system · Command reference

qzx getGpuInfo

What it does

Inspects installed GPUs and reports normalized vendor, driver, memory, and available utilization details

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.15. This page documents the 0.2.2.0.15 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

Uses nvidia-smi plus one platform inventory provider when available. Every subprocess uses an argument array without a shell, a bounded timeout, and structured warnings; provider errors never print into JSON stdout.

This safety classification was reviewed by Claude Opus 5.5 (Anthropic) against implementation digest sha256:608558045b07856ea567793851f1a97ad6d7c83fcd6f33f33cfeeb544f0e30dc on 2026-10-08.

Exact syntax

qzx getGpuInfo [detailed] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

NameTypeRequiredDefaultDescription
detailedboolNofalseRequest extended driver, memory, temperature, and utilization fields when the platform exposes them

Input examples

qzx getGpuInfo

List detected GPUs with normalized vendor names

qzx getGpuInfo --detailed

Include available driver, memory, temperature, and utilization fields

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

{
    "success": true,
    "message": "Detected 1 GPU from NVIDIA.",
    "gpus": [
        {
            "index": 0,
            "name": "NVIDIA GeForce RTX 4070",
            "vendor": "NVIDIA",
            "driver_version": "example-driver",
            "memory": {
                "total_mib": 12282,
                "used_mib": 2210,
                "free_mib": 10072
            },
            "utilization_percent": 18,
            "temperature_celsius": 44,
            "source": "nvidia-smi"
        }
    ],
    "gpu_count": 1,
    "detected_vendors": [
        "NVIDIA"
    ],
    "details": {
        "platform": "Windows",
        "detailed": true,
        "sources": [
            "nvidia-smi",
            "Win32_VideoController"
        ]
    },
    "meta": {
        "command": "getGpuInfo",
        "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
    }
}
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
        },
        "details": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "platform": [],
                        "detailed": [],
                        "sources": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "received": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "detected_vendors": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "gpu_count": [],
        "gpus": []
    },
    "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

Documentation channel
Development documentation 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
Availability
0.2.2.0.15 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