跳到主要内容

开发 · 命令参考

qzx getProjectTree

作用

生成有界的 ASCII 和 JSON 项目树，不跟随下级符号链接。

命令成熟度：Alpha

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

行为与内置保护

只检查，不改变状态

此操作直接执行

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

无需网络即可运行

设计为无需提权即可运行

此安全分类由 OpenAI GPT-5.6 Pro 于 2026-08-25 对照实现摘要 sha256:5ccd75d947b974cd586e89b171111614cb66a656e219b1152a344ec058f28aad 审阅。

准确语法

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

参数

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

名称类型必填默认值描述
dir_pathstr否"."要显示的目录（默认：当前目录）
max_depthint否2后代最大深度，0 到 64
exclude_dirsstr否".git,.idea,.next,.nuxt,.venv,.vscode,__pycache__,artifacts,build,dist,env,node_modules"要排除的目录名称，以逗号分隔；比较不区分大小写
include_filesbool否true除目录外也列出常规文件；链接始终显示，但绝不跟随
max_entriesint否10000保留的后代最大数量，1 到 100000（默认：10000）

输入示例

qzx getProjectTree

显示当前项目，最多两层后代

qzx getProjectTree src 3

显示 src 树，最多三层后代

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

最多显示 500 个目录或链接，并排除两个名称

要获得完整结构化载荷，请添加 --json： qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --json

代表性输出示例

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

示例命令： 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"
        }
    ]
}
查看 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
}

错误与限制

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

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

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

证据与来源

文档渠道
开发文档 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
可用性
0.2.2.0.9 或更早

继续探索

相关命令

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

浏览所有 QZX 命令