qzx getProjectTree

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx getProjectTree --json

{
    "success": true,
    "message": "Generates a clean visual directory tree (ASCII and JSON) excluding heavy directories like node_modules. In this illustrative example, the command completed successfully.",
    "dir_path": "C:\\project\\example.txt",
    "exclude_dirs": [
        ".git",
        "node_modules",
        "__pycache__"
    ],
    "include_files": true,
    "max_depth": "Example value",
    "tree_structure": {
        "name": "project",
        "children": [
            {
                "name": "src",
                "type": "directory"
            }
        ]
    },
    "tree_text": "project/\n└── src/\n    └── example.py"
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "dir_path": [],
        "error": {
            "type": "string"
        },
        "exclude_dirs": [],
        "include_files": [],
        "max_depth": [],
        "tree_structure": [],
        "tree_text": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: ready for deterministic automated capture.