system · Command reference

`qzx help`

What it does

Shows help for a command

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:4de1357916cb3f8525e215900ccd81e475f4fef8d707429ae09e34a5337fd58b on 2026-07-30.

Exact syntax

qzx help [command] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

Name	Type	Required	Default	Description
command	str	No	Not declared	Name of the command to get help for

Input examples

qzx help

Shows general help information

qzx help readFile

Shows detailed help for the readFile command

qzx readFile --help

Shows the same command help with the conventional flag

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

{
    "success": true,
    "message": "Shows help for a command. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "help",
        "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
    },
    "command": "qzx example --json",
    "details": {
        "name": "Example value",
        "requested_name": "Example value",
        "canonical_name": "Example value",
        "description": "Example value",
        "category": "Example value",
        "maturity": "Example value",
        "parameters": [
            {
                "name": "example",
                "status": "ok"
            }
        ],
        "examples": [
            {
                "name": "example",
                "status": "ok"
            }
        ]
    }
}

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
        },
        "command": [],
        "details": {
            "type": "object",
            "properties": {
                "name": [],
                "requested_name": [],
                "canonical_name": [],
                "description": [],
                "category": [],
                "maturity": [],
                "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.

Evidence and provenance

Implementation: src/qzx/commands/system/help.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

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