system · Command reference

`qzx runDiagnosticCommand`

What it does

Runs a strictly read-only native system diagnostic from a platform-specific allowlist

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

Runs only a platform-specific allowlist of read-only operating-system diagnostics. It rejects executable paths, bypasses PATH when selecting the diagnostic executable, resolves trusted system locations, disables shell expansion, and validates command-specific arguments. netstat and ss require numeric output without process attribution; ss also blocks Unix-domain socket paths. The child runs from the executable directory with a minimal non-secret environment, drains stdout and stderr concurrently within separate memory budgets, and has a 20-second timeout.

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

Exact syntax

qzx runDiagnosticCommand <command> [args] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
command	str	Yes	Not declared	Read-only diagnostic. Windows: hostname, ipconfig, netstat, whoami. Unix: cal, date, free, hostname, netstat, ss, uname, uptime, whoami
args	list[str]	No	[]	Arguments accepted by QZX's command-specific read-only grammar

Input examples

qzx runDiagnosticCommand hostname

Read the local system host name

qzx runDiagnosticCommand whoami

Read the current operating-system user

qzx runDiagnosticCommand uname -a

Read Unix kernel and architecture details

qzx runDiagnosticCommand ipconfig /all

Read the complete Windows network configuration

qzx runDiagnosticCommand netstat -an

List connections numerically without name resolution

For the complete structured payload, add --json: qzx runDiagnosticCommand <command> [args] --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 runDiagnosticCommand hostname --json

{
    "success": true,
    "message": "Runs a strictly read-only native system diagnostic from a platform-specific allowlist. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "runDiagnosticCommand",
        "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
    },
    "details": {
        "summary": "Additional structured context is included here."
    },
    "stdout": "Command completed successfully."
}

View the JSON result contract

{
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "oneOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ]
        },
        "error_code": {
            "type": "string"
        },
        "stdout": {
            "type": "string"
        },
        "stderr": {
            "type": "string"
        },
        "details": {
            "type": "object",
            "additionalProperties": true
        },
        "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
        }
    },
    "additionalProperties": true,
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": [
        "message",
        "meta",
        "success"
    ]
}

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: captured and digest-validated.

Evidence and provenance

Implementation: src/qzx/commands/system/run_diagnostic_command.py
Tests: tests/test_system_commands/test_run_diagnostic_command.py
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