Saltar al contenido principal

desarrollo · Referencia de comando

qzx getProjectTree

Qué hace

Genera un árbol acotado en ASCII y JSON sin seguir enlaces simbólicos descendientes.

Madurez del comando: Alpha

Disponible para uso real y retroalimentación mientras su interfaz y comportamiento todavía pueden evolucionar. Esta es la evaluación actual del checkout de desarrollo. Cada futuro tag inmutable de release conservará la evaluación exacta incluida en esa versión. Disponible en PyPI 0.2.2.0.8. La documentación corresponde al checkout alpha 0.2.2.0.8.

Comportamiento y protecciones integradas

Inspecciona sin cambiar el estado

Ejecución directa para esta operación

Funciona sin invocar programas nativos

Funciona sin usar la red

Diseñado para funcionar sin elevación

Esta clasificación de seguridad fue revisada por OpenAI GPT-5.6 Pro contra el digest de implementación sha256:5ccd75d947b974cd586e89b171111614cb66a656e219b1152a344ec058f28aad el 2026-08-25.

Sintaxis exacta

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

Parámetros

Desliza o usa la barra horizontal para ver todas las columnas.

NombreTipoObligatorioPredeterminadoDescripción
dir_pathstrNo"."Directorio que se visualizará (valor predeterminado: directorio actual)
max_depthintNo2Profundidad máxima de descendientes, de 0 a 64
exclude_dirsstrNo".git,.idea,.next,.nuxt,.venv,.vscode,__pycache__,artifacts,build,dist,env,node_modules"Nombres de directorios que se excluirán, separados por comas; la comparación no distingue mayúsculas de minúsculas
include_filesboolNotrueEnumera archivos regulares además de directorios; los enlaces siempre se muestran, pero nunca se siguen
max_entriesintNo10000Cantidad máxima de descendientes retenidos, de 1 a 100000 (valor predeterminado: 10000)

Ejemplos de entrada

qzx getProjectTree

Mostrar el proyecto actual hasta dos niveles de descendientes

qzx getProjectTree src 3

Mostrar el árbol de src hasta tres niveles de descendientes

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

Mostrar como máximo 500 directorios o enlaces y excluir dos nombres

Para obtener la carga estructurada completa, añade --json: qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: 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"
        }
    ]
}
Ver el contrato de resultado 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
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: lista para captura automática determinista.

Evidencia y procedencia

Canal de documentación
Documentación de desarrollo 0.2.2.0.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
Disponibilidad
0.2.2.0.8 o anterior

Sigue explorando

Comandos relacionados

Estos comandos también pertenecen a la categoría de desarrollo. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX