file · Command reference

`qzx readFile`

What it does

Reads and displays the content of a file

Canonical command: readFile

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:5f391ea1c2e64ecba1b24e298db374cf6d5e71c1c9af3db52b6a5c99f04ff544 on 2026-07-24.

Exact syntax

qzx readFile <file_path> [max_lines] --json

Parameters

Name	Type	Required	Default	Description
file_path	str	Yes	Not declared	Path to the file to read
max_lines	str	No	Not declared	Maximum number of lines to read (if not provided, reads the entire file)

Input examples

qzx readFile myfile.txt

Read the entire content of myfile.txt

qzx readFile myfile.txt 10

Read the first 10 lines of myfile.txt

qzx readFile "path with spaces/myfile.txt"

Read a file with spaces in the path

For the complete structured payload, add --json: qzx readFile <file_path> [max_lines] --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 readFile myfile.txt --json

{
    "success": true,
    "message": "Reads and displays the content of a file. In this illustrative example, the command completed successfully.",
    "content": "Example file contents.\nSecond line.",
    "details": {
        "path": "C:\\project\\example.txt"
    }
}

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"
        },
        "content": [],
        "details": {
            "type": "object",
            "properties": {
                "path": []
            },
            "additionalProperties": true
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        }
    },
    "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/read_file.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 file category. Compare them to choose the operation that best fits your task.

Explore all QZX commands