跳到主要内容

文件 · 命令参考

qzx readFile

作用

读取并显示文件内容。

命令成熟度：Alpha

可用于真实使用和反馈，但其接口与行为仍可能继续演进。 这是当前开发 checkout 的评估。未来每个不可变发布标签都会保留该版本中包含的准确评估。 可在 PyPI 0.2.2.0.15 使用。文档对应 alpha checkout 0.2.2.0.15。

行为与内置保护

只检查，不改变状态

此操作直接执行

无需调用原生程序即可运行

无需网络即可运行

设计为无需提权即可运行

此安全分类由 Claude Opus 5.5 (Anthropic) 于 2026-10-08 对照实现摘要 sha256:b747b8875f49807a91ee577a8604addb5c6fcdd6720c4f89271eddc9fae5fdff 审阅。

准确语法

qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --json

参数

滑动或使用横向滚动条查看所有列。

名称类型必填默认值描述
file_pathstr是未声明要读取的文本文件路径
max_linesint否未声明每页最大行数；省略时仅受 max_bytes 限制，不限制行数。设为 0 时不读取内容。
max_bytesint否65536每页源文件字节数（1 至 16777216，默认 65536），另读取四个字节以检测编码。不完整的字符留到下一页。
offsetint否0从 0 开始的源文件字节偏移量。请使用 next_read 返回的原始值继续读取，避免重复或丢失文本。
encodingstr否"auto"auto 检测 Unicode BOM；无 BOM 时要求 UTF-8。可显式指定 UTF-8/16/32、ASCII、Latin-1、CP1252、CP437 和 CP850，并执行严格解码。
expected_fingerprintstr否未声明可选的 stat 元数据指纹令牌，取自 next_read。拒绝页间常规文件变更；这不是内容哈希，也不是不可变快照。

输入示例

qzx readFile myfile.txt

读取最多 64 KiB 文本，保留 Unicode 和原始换行符

qzx readFile myfile.txt 10 --json

在字节预算内读取前十行，并检查 next_read

qzx readFile "path with spaces/myfile.txt"

读取路径中包含空格的文件

qzx readFile application.log --max-bytes 4096 --offset 0 --json

开始有界的日志读取流程，并使用返回的 next_read 值继续

qzx readFile legacy.txt --encoding cp1252 --json

读取已知为 Windows-1252 编码的文件，不替换带重音的字符

要获得完整结构化载荷，请添加 --json： qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --json

代表性输出示例

此示意 JSON 源自当前实现所支持的结果契约。它展示命令可能返回的内容，并不声称这是录制的实际执行；具体值会随输入、设备、权限和可选工具而变化。

示例命令： qzx readFile myfile.txt --json

{
    "success": true,
    "message": "Reads and displays the content of a file. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "readFile",
        "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
    },
    "content": "Example file contents.\nSecond line.",
    "details": {
        "summary": "Additional structured context is included here."
    }
}
查看 JSON 结果契约
{
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "content": {
            "type": "string"
        },
        "details": {
            "type": "object"
        },
        "error_code": {
            "type": "string"
        },
        "error": {
            "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
        }
    },
    "required": [
        "message",
        "meta",
        "success"
    ],
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": true
}

错误与限制

公开契约要求失败时返回 success=false 和具有描述性的 message。此目录尚未为每个命令声明专门的错误分类；请检查结果，不要推断不存在的错误码。

QZX 仍处于 alpha 阶段。可选依赖、权限和主机能力可能影响结果。

证据流程：可进行确定性自动捕获。

证据与来源

测试
未找到与模块同名的专用测试文件；这并不能证明完全没有测试覆盖。
文档渠道
开发文档 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
可用性
0.2.2.0.15 或更早

继续探索

相关命令

这些命令同样属于 文件 类别。对比它们，选择最适合解决任务的操作。

浏览所有 QZX 命令