file · Command reference

`qzx getFileHash`

What it does

Calculates cryptographic hashes (MD5, SHA-1, SHA-256) of a file

Canonical command: getFileHash

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:861f116b48ace165aa133aa8334707f40c620cae55dec8e5c2e132230aebbf27 on 2026-07-24.

Exact syntax

qzx getFileHash <file_path> [algorithm] --json

Parameters

Name	Type	Required	Default	Description
file_path	str	Yes	Not declared	Path to the file to hash
algorithm	str	No	"sha256"	Hash algorithm to use (sha256, sha1, md5)

Input examples

qzx getFileHash file.txt

Calculate SHA-256 hash for file.txt

qzx getFileHash file.txt md5

Calculate MD5 hash for file.txt

For the complete structured payload, add --json: qzx getFileHash <file_path> [algorithm] --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 getFileHash file.txt --json

{
    "success": true,
    "message": "Calculates cryptographic hashes (MD5, SHA-1, SHA-256) of a file. In this illustrative example, the command completed successfully.",
    "algorithm": "sha256",
    "file_path": "C:\\project\\example.txt",
    "file_size": 4096,
    "file_size_readable": "C:\\project\\example.txt",
    "hash": "a3f5c6d7e8f90123456789abcdef0123456789abcdef0123456789abcdef0123"
}

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"
        },
        "algorithm": [],
        "error": {
            "type": "string"
        },
        "file_path": [],
        "file_size": [],
        "file_size_readable": [],
        "hash": []
    },
    "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/file/get_file_hash.py
Tests: tests/test_file_commands/test_get_file_hash.py
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