development · Command reference

`qzx compareFiles`

What it does

Compares two files and reports their differences

Canonical command: compareFiles

Accepted aliases: None

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:9beea0a456a9cf4579c2ec48af638403b4196ce23814f981f05c090dae35ad8f on 2026-07-24.

Exact syntax

qzx compareFiles <file1> <file2> [mode] --json

Parameters

Name	Type	Required	Default	Description
file1	str	Yes	Not declared	Ruta al primer archivo
file2	str	Yes	Not declared	Ruta al segundo archivo
mode	str	No	"full"	Modo de comparación: "full" (completo), "summary" (resumen) o "percent" (porcentaje)

Input examples

qzx compareFiles "archivo1.py" "archivo2.py"

Comparar dos archivos Python y mostrar todas las diferencias

qzx compareFiles "archivo1.txt" "archivo2.txt" "summary"

Mostrar un resumen de diferencias entre dos archivos de texto

qzx compareFiles "versión1.js" "versión2.js" "percent"

Mostrar el porcentaje de similitud entre dos archivos JavaScript

For the complete structured payload, add --json: qzx compareFiles <file1> <file2> [mode] --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 compareFiles "archivo1.py" "archivo2.py" --json

{
    "success": true,
    "message": "Compares two files and reports their differences. In this illustrative example, the command completed successfully.",
    "file1": "C:\\project\\example.txt",
    "file2": "C:\\project\\example.txt",
    "mode": "default",
    "result": "Example value"
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "type": "string"
        },
        "file1": [],
        "file2": [],
        "mode": [],
        "result": []
    },
    "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: ready for deterministic automated capture.

Evidence and provenance

Implementation: src/qzx/commands/development/compare_files.py
Tests: No command-specific test file with the same module name was found; this does not prove that all coverage is absent.
Documentation channel: Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability: 0.2.2.0.2 or earlier

Keep exploring

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

Explore all QZX commands