Lewati ke konten utama

pengembangan · Referensi perintah

qzx getProjectTree

Apa fungsinya

Menghasilkan tree terbatas dalam ASCII dan JSON tanpa mengikuti symbolic link turunan.

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:5ccd75d947b974cd586e89b171111614cb66a656e219b1152a344ec058f28aad pada 2026-08-25.

Sintaks persis

qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --json

Parameter

Geser atau gunakan bilah horizontal untuk melihat semua kolom.

NamaTipeWajibDefaultDeskripsi
dir_pathstrTidak"."Direktori yang akan divisualisasikan (default: direktori saat ini)
max_depthintTidak2Kedalaman maksimum turunan, dari 0 hingga 64
exclude_dirsstrTidak".git,.idea,.next,.nuxt,.venv,.vscode,__pycache__,artifacts,build,dist,env,node_modules"Nama direktori yang dikecualikan, dipisahkan koma; pencocokan tidak membedakan huruf besar/kecil
include_filesboolTidaktrueMencantumkan file reguler selain direktori; link selalu ditampilkan tetapi tidak pernah diikuti
max_entriesintTidak10000Jumlah maksimum turunan yang dipertahankan, dari 1 hingga 100000 (default: 10000)

Contoh input

qzx getProjectTree

Tampilkan proyek saat ini hingga dua tingkat turunan

qzx getProjectTree src 3

Tampilkan tree src hingga tiga tingkat turunan

qzx getProjectTree . 2 .git,node_modules false --max_entries 500

Tampilkan maksimum 500 direktori atau link dan kecualikan dua nama

Untuk mendapatkan payload terstruktur lengkap, tambahkan --json: qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --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 getProjectTree --json

{
    "success": true,
    "message": "Generates one bounded ASCII and JSON directory tree without following descendant symbolic links. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "getProjectTree",
        "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
    },
    "details": {
        "summary": "Additional structured context is included here."
    },
    "dir_path": "C:\\project\\example.txt",
    "exclude_dirs": [
        ".git",
        "node_modules",
        "__pycache__"
    ],
    "include_files": true,
    "max_depth": "Example value",
    "max_entries": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "tree_structure": {
        "name": "project",
        "children": [
            {
                "name": "src",
                "type": "directory"
            }
        ]
    },
    "tree_text": "project/\n└── src/\n    └── example.py",
    "warnings": [
        {
            "name": "example",
            "status": "ok"
        }
    ]
}
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
        },
        "details": [],
        "dir_path": [],
        "error": {
            "type": "string"
        },
        "error_code": {
            "type": "string"
        },
        "exclude_dirs": [],
        "include_files": [],
        "max_depth": [],
        "max_entries": [],
        "tree_structure": [],
        "tree_text": [],
        "warnings": []
    },
    "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

Kanal dokumentasi
Dokumentasi pengembangan 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
Ketersediaan
0.2.2.0.9 atau lebih lama

Lanjut jelajahi

Perintah terkait

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

Jelajahi semua perintah QZX