file · Referensi perintah

`qzx readFile`

Apa fungsinya

Membaca dan menampilkan isi file.

Kematangan perintah: Alpha

Tersedia untuk penggunaan nyata dan umpan balik sementara antarmuka serta perilakunya masih dapat berkembang. Ini adalah evaluasi saat ini untuk checkout pengembangan. Setiap tag rilis immutable di masa mendatang akan mempertahankan evaluasi persis yang disertakan dalam versi tersebut. Tersedia di PyPI 0.2.2.0.15. Dokumentasi ini sesuai dengan checkout alpha 0.2.2.0.15.

Perilaku dan perlindungan bawaan

Memeriksa tanpa mengubah status

Eksekusi langsung untuk operasi ini

Berfungsi tanpa memanggil program native

Berfungsi tanpa menggunakan jaringan

Dirancang untuk bekerja tanpa elevasi hak akses

Klasifikasi keamanan ini ditinjau oleh Claude Opus 5.5 (Anthropic) terhadap digest implementasi sha256:b747b8875f49807a91ee577a8604addb5c6fcdd6720c4f89271eddc9fae5fdff pada 2026-10-08.

Sintaks persis

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

Parameter

Geser atau gunakan bilah horizontal untuk melihat semua kolom.

Nama	Tipe	Wajib	Default	Deskripsi
file_path	str	Ya	Tidak dideklarasikan	Jalur berkas teks yang akan dibaca
max_lines	int	Tidak	Tidak dideklarasikan	Jumlah maksimum baris per halaman; jika dihilangkan, jumlah baris hanya dibatasi oleh max_bytes. Nol tidak membaca isi.
max_bytes	int	Tidak	65536	Jumlah byte sumber per halaman (1 hingga 16777216; bawaan 65536), ditambah pemeriksaan pengodean empat byte. Karakter yang belum lengkap disisakan untuk halaman berikutnya.
offset	int	Tidak	0	Posisi byte sumber dimulai dari nol. Gunakan nilai next_read persis seperti yang dikembalikan agar teks tidak berulang atau hilang.
encoding	str	Tidak	"auto"	auto mendeteksi BOM Unicode; tanpa BOM, berkas harus berupa UTF-8. Mendukung UTF-8/16/32, ASCII, Latin-1, CP1252, CP437, dan CP850 secara eksplisit dengan dekode ketat.
expected_fingerprint	str	Tidak	Tidak dideklarasikan	Token sidik jari metadata stat opsional dari next_read. Menolak perubahan berkas yang terdeteksi antarahalaman; bukan hash isi atau snapshot yang tidak dapat berubah.

Contoh input

qzx readFile myfile.txt

Baca hingga 64 KiB teks dengan mempertahankan Unicode dan akhir baris aslinya

qzx readFile myfile.txt 10 --json

Baca sepuluh baris pertama dalam batas byte dan periksa next_read

qzx readFile "path with spaces/myfile.txt"

Baca berkas yang jalurnya mengandung spasi

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

Mulai pembacaan log dengan batas tertentu; lanjutkan menggunakan nilai next_read yang dikembalikan

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

Baca berkas yang diketahui menggunakan Windows-1252 tanpa mengganti karakter beraksen

Untuk mendapatkan payload terstruktur lengkap, tambahkan --json: qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --json

Contoh output representatif

JSON ilustratif ini berasal dari kontrak hasil yang didukung implementasi saat ini. Ini menunjukkan apa yang dapat dikembalikan perintah tanpa mengklaim sebagai eksekusi yang direkam; nilainya bervariasi menurut input, mesin, izin, dan alat opsional.

Perintah contoh: 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."
    }
}

Lihat kontrak hasil 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
}

Kesalahan dan batasan

Kontrak publik mensyaratkan success=false dan message yang deskriptif saat gagal. Katalog ini belum mendeklarasikan taksonomi kesalahan khusus untuk setiap perintah; periksa hasil dan jangan menyimpulkan kode yang tidak ada.

QZX masih dalam tahap alpha. Dependency opsional, izin, dan kemampuan host dapat mengubah hasil.

Alur bukti: siap untuk penangkapan otomatis deterministik.

Bukti dan asal-usul

Implementasi: src/qzx/commands/file/read_file.py
Pengujian: Tidak ditemukan file pengujian khusus dengan nama modul yang sama; ini tidak membuktikan bahwa cakupan pengujian sama sekali tidak ada.
Kanal dokumentasi: Dokumentasi pengembangan 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
Ketersediaan: 0.2.2.0.15 atau lebih lama

Lanjut jelajahi

Perintah ini juga termasuk kategori file. Bandingkan untuk memilih operasi yang paling sesuai bagi tugas Anda.

Jelajahi semua perintah QZX