qzx compressZip

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 compressZip project.zip . --json

{
    "success": true,
    "message": "Compresses a directory or file into a ZIP archive with custom exclusion rules. In this illustrative example, the command completed successfully.",
    "compressed_bytes": 4096,
    "compression_ratio_percent": 42.7,
    "files_archived": "C:\\project\\example.txt",
    "original_bytes": 4096,
    "source_path": "C:\\project\\example.txt",
    "zip_path": "C:\\project\\example.txt"
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "compressed_bytes": [],
        "compression_ratio_percent": [],
        "error": {
            "type": "string"
        },
        "files_archived": [],
        "original_bytes": [],
        "source_path": [],
        "zip_path": []
    },
    "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: requires an isolated disposable target.