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.9. Dokumentasi ini sesuai dengan checkout alpha 0.2.2.0.9.

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 OpenAI GPT-5.6 Pro terhadap digest implementasi sha256:9f34106a5e73c2b0f2a75351d0f69bd2c2a4394e4f518fe97dfbbfcf3f8fc235 pada 2026-08-25.

Sintaks persis

qzx readFile <file_path> [max_lines] --json

Parameter

Geser atau gunakan bilah horizontal untuk melihat semua kolom.

Nama	Tipe	Wajib	Default	Deskripsi
file_path	str	Ya	Tidak dideklarasikan	Jalur file yang akan dibaca
max_lines	str	Tidak	Tidak dideklarasikan	Jumlah maksimum baris yang dibaca (jika tidak ditentukan, seluruh file dibaca)

Contoh input

qzx readFile myfile.txt

Baca seluruh isi myfile.txt

qzx readFile myfile.txt 10

Baca 10 baris pertama myfile.txt

qzx readFile "path with spaces/myfile.txt"

Baca file yang jalurnya mengandung spasi

Untuk mendapatkan payload terstruktur lengkap, tambahkan --json: qzx readFile <file_path> [max_lines] --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": {
        "path": "C:\\project\\example.txt"
    }
}

Lihat kontrak hasil JSON

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message",
        "meta"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "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
        },
        "content": [],
        "details": {
            "type": "object",
            "properties": {
                "path": []
            },
            "additionalProperties": true
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        }
    },
    "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.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Ketersediaan: 0.2.2.0.9 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