qzx qzxHelp

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

{
    "success": true,
    "message": "Shows help for a command. In this illustrative example, the command completed successfully.",
    "command": "qzx example --json",
    "details": {
        "name": "Example value",
        "description": "Example value",
        "category": "Example value",
        "parameters": [
            {
                "name": "example",
                "status": "ok"
            }
        ],
        "examples": [
            {
                "name": "example",
                "status": "ok"
            }
        ]
    }
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "command": [],
        "details": {
            "type": "object",
            "properties": {
                "name": [],
                "description": [],
                "category": [],
                "parameters": [],
                "examples": []
            },
            "additionalProperties": true
        },
        "error": {
            "type": "string"
        }
    },
    "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.