Skip to main content

file · Command reference

qzx extractZip

What it does

Extracts files from a ZIP archive after validating paths, types, limits, and destination conflicts

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.9. This page documents the 0.2.2.0.9 alpha development checkout.

Behavior and built-in protections

Live mode applies the changes you request

Direct execution for this operation

Works without invoking native programs

Works without network access

Uses your current permissions; results can vary

Validates every member, rejects traversal, special files, ambiguous paths and configured expansion limits, and stages content before committing. Existing files are preserved by default; --overwrite requires a fail-closed backup of the target directory.

QZX creates a recovery archive before live changes; use --dangerously-bypass-approvals-and-sandbox/--yolo only when you deliberately choose to skip it.

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:b52eb98eba07d3cdf3e523b0976c9256e1a7e870d264ae02bb40d20dbbbf1490 on 2026-08-25.

Exact syntax

qzx extractZip <zip_path> [target_path] [overwrite] [max_files] [max_total_size_mb] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

NameTypeRequiredDefaultDescription
zip_pathstrYesNot declaredPath to the ZIP file to extract
target_pathstrNo"."Destination directory to extract files into (defaults to current directory)
overwriteboolNofalseReplace conflicting destination entries after backing up the target directory
max_filesintNo10000Maximum number of files accepted from the archive
max_total_size_mbintNo1024Maximum total uncompressed size accepted, in mebibytes

Input examples

qzx extractZip project.zip

Extract project.zip without replacing existing files

qzx extractZip project.zip C:/extracted-app

Extract project.zip into C:/extracted-app

qzx extractZip project.zip C:/extracted-app --overwrite

Replace conflicts after creating a target-directory backup

For the complete structured payload, add --json: qzx extractZip <zip_path> [target_path] [overwrite] [max_files] [max_total_size_mb] --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 extractZip project.zip --json

{
    "success": true,
    "message": "Extracts files from a ZIP archive after validating paths, types, limits, and destination conflicts. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "extractZip",
        "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
    },
    "details": {
        "summary": "Additional structured context is included here."
    },
    "directories_created": "Example value",
    "files_extracted": "C:\\project\\example.txt",
    "files_replaced": "C:\\project\\example.txt",
    "limits": {
        "max_files": "C:\\project\\example.txt",
        "max_total_size_mb": "Example value"
    },
    "overwrite": true,
    "skipped_traversals": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "target_path": "C:\\project\\example.txt",
    "total_bytes_extracted": 3,
    "total_size_readable": 3,
    "zip_path": "C:\\project\\example.txt"
}
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
        },
        "details": [],
        "directories_created": [],
        "error": [],
        "error_code": [],
        "files_extracted": [],
        "files_replaced": [],
        "limits": {
            "type": "object",
            "properties": {
                "max_files": [],
                "max_total_size_mb": []
            },
            "additionalProperties": true
        },
        "overwrite": [],
        "skipped_traversals": {
            "type": "array"
        },
        "target_path": [],
        "total_bytes_extracted": [],
        "total_size_readable": [],
        "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 a controlled privileged environment.

Evidence and provenance

Documentation channel
Development documentation 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Availability
0.2.2.0.9 or earlier

Keep exploring

Related commands

These commands also belong to the file category. Compare them to choose the operation that best fits your task.

Explore all QZX commands