file · Command reference

qzx inspectImage

What it does

Inspects image dimensions, format, and size natively from headers (supports PNG, JPEG, GIF, BMP)

Canonical command: inspectImage

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:0cb8467895c88d704d5a3d703bac422bb95e72ed5155d91506e85b4490026ee8 on 2026-07-24.

Exact syntax

qzx inspectImage <image_path> --json

Parameters

NameTypeRequiredDefaultDescription
image_pathstrYesNot declaredPath to the image file to inspect

Input examples

qzx inspectImage image.png

Inspect dimensions and format of image.png

For the complete structured payload, add --json: qzx inspectImage <image_path> --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 inspectImage image.png --json

{
    "success": true,
    "message": "Inspects image dimensions, format, and size natively from headers (supports PNG, JPEG, GIF, BMP). In this illustrative example, the command completed successfully.",
    "color_depth": 3,
    "file_bytes": 4096,
    "file_path": "C:\\project\\example.txt",
    "file_size_readable": "C:\\project\\example.txt",
    "format": "json",
    "height": 3,
    "width": 3
}
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"
        },
        "color_depth": [],
        "error": {
            "type": "string"
        },
        "file_bytes": [],
        "file_path": [],
        "file_size_readable": [],
        "format": [],
        "height": [],
        "width": []
    },
    "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

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 file category. Compare them to choose the operation that best fits your task.

Explore all QZX commands