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.6a11. This page documents the 0.2.2.0.6a11 alpha development checkout.

Safety and effects

Can mutate state

No documented dry-run parameter

No native program invocation in the current classification

No documented network use

Outcome may depend on permissions

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.

Before mutation, QZX creates a recovery archive; --dangerously-bypass-approvals-and-sandbox/--yolo explicitly skips it.

This safety classification was reviewed by OpenAI Codex (authorized project audit) against implementation digest sha256:368d8794dddd77bf435738e135fbc2e02f3f9f58b84a581b2c0fb06dfd093da4 on 2026-07-30.

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.

Name	Type	Required	Default	Description
zip_path	str	Yes	Not declared	Path to the ZIP file to extract
target_path	str	No	"."	Destination directory to extract files into (defaults to current directory)
overwrite	bool	No	false	Replace conflicting destination entries after backing up the target directory
max_files	int	No	10000	Maximum number of files accepted from the archive
max_total_size_mb	int	No	1024	Maximum 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
    },
    "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
        },
        "directories_created": [],
        "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

Implementation: src/qzx/commands/file/extract_zip.py
Tests: tests/test_file_commands/test_extract_zip.py
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 file category. Compare them to choose the operation that best fits your task.

Explore all QZX commands