qzx help

Exemplo de saída observada

Capturado com QZX 0.2.2.0.9 no Windows 11; código de saída 0. Valores dependentes do host e a duração podem variar.

Comando do exemplo: qzx help findFiles --json

{
    "success": true,
    "command": "findFiles",
    "message": "Command: findFiles\nDescription: Finds files by name, depth, size, and modification date with structured metadata\nMaturity: Alpha\n  Available for real use and feedback while its interface and behavior can still evolve.\n\nParameters:\n  - search_path: Directory where the search starts [Optional (Default: .)]\n  - pattern: File name glob such as *.txt or data-???.csv; defaults to all files [Optional (Default: *)]\n  - recursive: Search depth: -r for unlimited, false for this directory only, or -rN for N levels [Optional (Default: -r)]\n  - min_size: Minimum size, for example 500KB, 10MiB, or bytes [Optional]\n  - max_size: Maximum size, for example 2GB, 20MiB, or bytes [Optional]\n  - modified_after: Only files modified at or after YYYY-MM-DD, \"today\", or \"yesterday\" [Optional]\n  - modified_before: Only files modified before YYYY-MM-DD, \"today\", or \"yesterday\" [Optional]\n  - exclude: Comma-separated file-name globs to exclude [Optional]\n  - exclude_dirs: Comma-separated directory-name globs to skip [Optional]\n  - sort_by: Sort by path, name, size, or modified [Optional (Default: path)]\n  - descending: Reverse the selected sort order (true/false) [Optional (Default: False)]\n  - limit: Maximum number of files returned after sorting [Optional]\n\nExamples:\n  qzx findFiles . \"*.py\" --exclude-dirs \".git,.venv\"\n    Find Python files recursively while skipping common metadata directories\n  qzx findFiles Downloads \"*\" --min-size 100MiB --sort-by size --descending true --limit 20\n    Return the 20 largest matching files of at least 100 MiB\n  qzx findFiles logs \"*.log\" --modified-after 2026-07-01 --recursive false\n    Find recently modified log files in one directory\n",
    "details": {
        "name": "findFiles",
        "requested_name": "findFiles",
        "canonical_name": "findFiles",
        "description": "Finds files by name, depth, size, and modification date with structured metadata",
        "category": "file",
        "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"
        },
        "parameters": [
            {
                "name": "search_path",
                "description": "Directory where the search starts",
                "required": false,
                "default": "."
            },
            {
                "name": "pattern",
                "description": "File name glob such as *.txt or data-???.csv; defaults to all files",
                "required": false,
                "default": "*"
            },
            {
                "name": "recursive",
                "description": "Search depth: -r for unlimited, false for this directory only, or -rN for N levels",
                "required": false,
                "default": "-r"
            },
            {
                "name": "min_size",
                "description": "Minimum size, for example 500KB, 10MiB, or bytes",
                "required": false,
                "default": null
            },
            {
                "name": "max_size",
                "description": "Maximum size, for example 2GB, 20MiB, or bytes",
                "required": false,
                "default": null
            },
            {
                "name": "modified_after",
                "description": "Only files modified at or after YYYY-MM-DD, \"today\", or \"yesterday\"",
                "required": false,
                "default": null
            },
            {
                "name": "modified_before",
                "description": "Only files modified before YYYY-MM-DD, \"today\", or \"yesterday\"",
                "required": false,
                "default": null
            },
            {
                "name": "exclude",
                "description": "Comma-separated file-name globs to exclude",
                "required": false,
                "default": null
            },
            {
                "name": "exclude_dirs",
                "description": "Comma-separated directory-name globs to skip",
                "required": false,
                "default": null
            },
            {
                "name": "sort_by",
                "description": "Sort by path, name, size, or modified",
                "required": false,
                "default": "path"
            },
            {
                "name": "descending",
                "description": "Reverse the selected sort order (true/false)",
                "required": false,
                "default": false
            },
            {
                "name": "limit",
                "description": "Maximum number of files returned after sorting",
                "required": false,
                "default": null
            }
        ],
        "examples": [
            {
                "command": "qzx findFiles . \"*.py\" --exclude-dirs \".git,.venv\"",
                "description": "Find Python files recursively while skipping common metadata directories"
            },
            {
                "command": "qzx findFiles Downloads \"*\" --min-size 100MiB --sort-by size --descending true --limit 20",
                "description": "Return the 20 largest matching files of at least 100 MiB"
            },
            {
                "command": "qzx findFiles logs \"*.log\" --modified-after 2026-07-01 --recursive false",
                "description": "Find recently modified log files in one directory"
            }
        ]
    },
    "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": 9.04,
        "schema_version": 1
    }
}

{
    "$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": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "requested": [],
                        "suggestions": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "name": [],
                        "requested_name": [],
                        "canonical_name": [],
                        "description": [],
                        "category": [],
                        "maturity": [],
                        "parameters": [],
                        "examples": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        }
    },
    "additionalProperties": true
}

Erros e limites

O contrato público exige success=false e uma message descritiva em caso de falha. Este catálogo ainda não declara uma taxonomia de erros específica para cada comando; revise o resultado e não infira códigos inexistentes.

O QZX está em alpha. Dependências opcionais, permissões e recursos do host podem alterar o resultado.

{
    "success": false,
    "error": "Command not found: definitelyMissingGoldenCoreCommand",
    "error_code": "command_not_found",
    "message": "Command 'definitelyMissingGoldenCoreCommand' was not found. Use 'qzx listCommands' to see available commands.",
    "details": {
        "requested": "definitelyMissingGoldenCoreCommand",
        "suggestions": []
    },
    "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": 9.376,
        "schema_version": 1
    }
}

Comando capturado: qzx help definitelyMissingGoldenCoreCommand --json

Fluxo de evidência: capturada e validada por digest.