archivos · Referencia de comando

`qzx compressZip`

Qué hace

Comprime un archivo o directorio en un ZIP con reglas de exclusión configurables.

Comando canónico: compressZip

Alias aceptados: Ninguno

Distingue mayúsculas: no

Incluido en el paquete publicado

Disponible en PyPI 0.2.2.0.2. La documentación corresponde al checkout alpha 0.2.2.0.2.

Seguridad y efectos

Puede modificar estado

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 se revisó contra el digest de implementación sha256:651a7f9a88ee02539960b1bfe07593de7f15d2a0d4d8f1aad0caad3a9ab0fbbe el 2026-07-24.

Sintaxis exacta

qzx compressZip <zip_path> <source_path> [exclude_patterns] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
zip_path	str	Sí	No declarado	Target path for the created ZIP archive (e.g. project.zip)
source_path	str	Sí	No declarado	Local file or directory to compress
exclude_patterns	str	No	".git,node_modules,__pycache__,.venv,env,dist,build"	Comma-separated folders, files, or wildcards to exclude (defaults to standard caches)

Ejemplos de entrada

qzx compressZip project.zip .

Compress the current directory into project.zip, excluding standard build folders

qzx compressZip src.zip src

Compress the src folder into src.zip

Para obtener la carga estructurada completa, añade --json: qzx compressZip <zip_path> <source_path> [exclude_patterns] --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 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"
}

Ver el contrato de resultado JSON

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

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: requiere un destino desechable aislado.

Evidencia y procedencia

Implementación: src/qzx/commands/file/compress_zip.py
Pruebas: tests/test_file_commands/test_compress_zip.py
Canal de documentación: Documentación de desarrollo 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Disponibilidad: 0.2.2.0.2 o anterior

Sigue explorando

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

Explorar todos los comandos de QZX