arquivos · Referência do comando

`qzx createZip`

O que faz

Cria um arquivo ZIP atômico a partir de um arquivo ou diretório, com regras de exclusão configuráveis.

Maturidade do comando: Alpha

Disponível para uso real e feedback enquanto a interface e o comportamento ainda podem evoluir. Esta é a avaliação atual do checkout de desenvolvimento. Cada tag de release imutável futuro preservará a avaliação exata incluída nessa versão. Disponível no PyPI 0.2.2.0.9. A documentação corresponde ao checkout alpha 0.2.2.0.9.

Comportamento e proteções integradas

O modo real aplica as alterações solicitadas

Execução direta para esta operação

Funciona sem invocar programas nativos

Funciona sem usar a rede

Usa suas permissões atuais; o resultado pode variar

O QZX constrói o ZIP em um arquivo temporário adjacente e só o publica quando está completo. Preserva destinos existentes por padrão, ignora links simbólicos e rejeita usar o mesmo objeto como origem e destino. --overwrite exige primeiro um backup recuperável do ZIP anterior.

O QZX cria um arquivo de recuperação antes das alterações reais; use --dangerously-bypass-approvals-and-sandbox/--yolo somente quando decidir ignorá-lo deliberadamente.

Esta classificação de segurança foi revisada por OpenAI GPT-5.6 Pro em relação ao digest de implementação sha256:ee0976439603ebc86ae05188b804c51c0f0e159b474900af8d2e22b1852dbbc9 em 2026-08-25.

Sintaxe exata

qzx createZip <zip_path> <source_path> [exclude_patterns] [overwrite] --json

Parâmetros

Deslize ou use a barra horizontal para ver todas as colunas.

Nome	Tipo	Obrigatório	Padrão	Descrição
zip_path	str	Sim	Não declarado	Caminho de destino do arquivo ZIP que será criado (por exemplo, project.zip)
source_path	str	Sim	Não declarado	Arquivo ou diretório local que será compactado
exclude_patterns	str	Não	".git,node_modules,__pycache__,.venv,env,dist,build"	Pastas, arquivos ou curingas a excluir, separados por vírgulas (padrão: caches comuns)
overwrite	bool	Não	false	Substitui um ZIP existente depois de criar um backup de segurança

Exemplos de entrada

qzx createZip project.zip .

Compactar o diretório atual em um novo project.zip

qzx createZip src.zip src

Compactar a pasta src em um novo src.zip

qzx createZip project.zip . --overwrite

Substituir project.zip depois de criar um backup de segurança

Para obter o payload estruturado completo, adicione --json: qzx createZip <zip_path> <source_path> [exclude_patterns] [overwrite] --json

Exemplo de saída representativa

Este JSON ilustrativo deriva do contrato de resultado respaldado pela implementação atual. Mostra o que o comando pode retornar sem afirmar que seja uma execução gravada; os valores variam conforme entradas, máquina, permissões e ferramentas opcionais.

Comando do exemplo: qzx createZip project.zip . --json

{
    "success": true,
    "message": "Compresses a file or directory into an atomic ZIP archive with custom exclusion rules. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "createZip",
        "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
    },
    "compressed_bytes": 4096,
    "compression_ratio_percent": 42.7,
    "details": {
        "summary": "Additional structured context is included here."
    },
    "files_archived": "C:\\project\\example.txt",
    "original_bytes": 4096,
    "overwrite": true,
    "sha256": "Example value",
    "skipped_symlinks": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "source_path": "C:\\project\\example.txt",
    "zip_path": "C:\\project\\example.txt"
}

Ver o contrato de resultado JSON

{
    "$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
        },
        "compressed_bytes": [],
        "compression_ratio_percent": [],
        "details": [],
        "error": [],
        "error_code": [],
        "files_archived": [],
        "original_bytes": [],
        "overwrite": [],
        "sha256": [],
        "skipped_symlinks": [],
        "source_path": [],
        "zip_path": []
    },
    "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.

Fluxo de evidência: requer um ambiente privilegiado controlado.

Evidência e procedência

Implementação: src/qzx/commands/file/create_zip.py
Testes: tests/test_file_commands/test_create_zip.py
Canal de documentação: Documentação de desenvolvimento 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Disponibilidade: 0.2.2.0.9 ou anterior

Continue explorando

Estes comandos também pertencem à categoria arquivos. Compare-os para escolher a operação que melhor resolve sua tarefa.

Explorar todos os comandos do QZX