sistema · Referencia de comando

`qzx help`

Qué hace

Muestra ayuda para un comando.

Madurez del comando: Alpha

Disponible para uso real y retroalimentación mientras su interfaz y comportamiento todavía pueden evolucionar. Esta es la evaluación actual del checkout de desarrollo. Cada futuro tag inmutable de release conservará la evaluación exacta incluida en esa versión. Disponible en PyPI 0.2.2.0.6a11. La documentación corresponde al checkout alpha 0.2.2.0.6a11.

Seguridad y efectos

Solo lectura según la clasificación actual

Sin parámetro dry-run documentado

No invoca programas nativos según la clasificación

Sin uso de red documentado

No requiere elevación de forma inherente

Esta clasificación de seguridad fue revisada por OpenAI Codex (authorized project audit) contra el digest de implementación sha256:4de1357916cb3f8525e215900ccd81e475f4fef8d707429ae09e34a5337fd58b el 2026-07-30.

Sintaxis exacta

qzx help [command] --json

Parámetros

Desliza o usa la barra horizontal para ver todas las columnas.

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
command	str	No	No declarado	Nombre del comando del que se obtendrá ayuda

Ejemplos de entrada

qzx help

Mostrar la información de ayuda general

qzx help readFile

Mostrar la ayuda detallada del comando readFile

qzx readFile --help

Mostrar la misma ayuda mediante el flag convencional del comando

Para obtener la carga estructurada completa, añade --json: qzx help [command] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: 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"
            }
        ]
    }
}

Ver el contrato de resultado JSON

{
    "$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
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: lista para captura automática determinista.

Evidencia y procedencia

Implementación: src/qzx/commands/system/help.py
Pruebas: No se encontró un archivo de prueba específico con el mismo nombre de módulo; esto no demuestra ausencia total de cobertura.
Canal de documentación: Documentación de desarrollo 0.2.2.0.6a11 · main · sha256:d1bf56371df81b2a79619d8219eed92ccf790be1584c528e211381ca7aa85302
Disponibilidad: 0.2.2.0.6a11 o anterior

Sigue explorando

Estos comandos también pertenecen a la categoría de sistema. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX