desarrollo · Referencia de comando
qzx getProjectTree
Qué hace
Genera un árbol visual limpio en ASCII y JSON, excluyendo directorios pesados como node_modules.
Comando canónico: getProjectTree
Alias aceptados: Ninguno
Distingue mayúsculas: no
Incluido en el paquete publicado
Disponible en PyPI 0.2.2.0.2. La documentación corresponde al checkout alpha 0.2.2.0.2.
Seguridad y efectos
Solo lectura según la clasificación actual
Sin parámetro dry-run documentado
No invoca programas nativos según la clasificación
Sin uso de red documentado
No requiere elevación de forma inherente
Esta clasificación de seguridad se revisó contra el digest de implementación sha256:82c9cad2346beab0e81862adde91a61cf4f3218282009b54249bc5c357dab9ba el 2026-07-24.
Sintaxis exacta
qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] --jsonParámetros
| Nombre | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
| dir_path | str | No | "." | Path to the directory to visualize (defaults to current directory) |
| max_depth | str | No | "2" | Maximum depth level of the tree (defaults to 2) |
| exclude_dirs | str | No | ".git,node_modules,__pycache__,.venv,env,dist,build,artifacts,.next,.nuxt,.idea,.vscode" | Comma-separated directory names to exclude (defaults to standard caches and configs) |
| include_files | str | No | "true" | Whether to list files as well as directories (true/false) |
Ejemplos de entrada
qzx getProjectTreeShow directory tree for the current folder up to 2 levels deep
qzx getProjectTree src 3Show directory tree for the src folder up to 3 levels deep
qzx getProjectTree . 2 .git,node_modules falseShow directory tree excluding only .git and node_modules, showing folders only
Para obtener la carga estructurada completa, añade --json: qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] --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 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"
}Ver el contrato de resultado JSON
{
"$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
}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
- Implementación
- src/qzx/commands/development/get_project_tree.py
- Canal de documentación
- Documentación de desarrollo 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
- Disponibilidad
- 0.2.2.0.2 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.
qzx getGitStatusProporciona un resumen estructurado del estado de Git: rama, remoto, cambios y commits recientes.qzx projectDoctorInspecciona tecnologías, dependencias, entorno, Git, pruebas, importaciones circulares, código muerto y archivos grandes.qzx formatCodeDetecta el lenguaje y ejecuta el formateador correspondiente sobre archivos de código fuente.qzx projectLanguagesPerfila los lenguajes fuente y formatos auxiliares de un proyecto con porcentajes por líneas, archivos y bytes.