desenvolvimento · Referência do comando
qzx getProjectTree
O que faz
Gera uma árvore limitada em ASCII e JSON sem seguir links simbólicos descendentes.
Maturidade do comando: Alpha
Disponível para uso real e feedback enquanto a interface e o comportamento ainda podem evoluir. Esta é a avaliação atual do checkout de desenvolvimento. Cada tag de release imutável futuro preservará a avaliação exata incluída nessa versão. Disponível no PyPI 0.2.2.0.9. A documentação corresponde ao checkout alpha 0.2.2.0.9.
Comportamento e proteções integradas
Inspeciona sem alterar o estado
Execução direta para esta operação
Funciona sem invocar programas nativos
Funciona sem usar a rede
Projetado para funcionar sem elevação
Esta classificação de segurança foi revisada por OpenAI GPT-5.6 Pro em relação ao digest de implementação sha256:5ccd75d947b974cd586e89b171111614cb66a656e219b1152a344ec058f28aad em 2026-08-25.
Sintaxe exata
qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --jsonParâmetros
Deslize ou use a barra horizontal para ver todas as colunas.
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| dir_path | str | Não | "." | Diretório que será visualizado (padrão: diretório atual) |
| max_depth | int | Não | 2 | Profundidade máxima de descendentes, de 0 a 64 |
| exclude_dirs | str | Não | ".git,.idea,.next,.nuxt,.venv,.vscode,__pycache__,artifacts,build,dist,env,node_modules" | Nomes de diretórios a excluir, separados por vírgulas; a comparação não diferencia maiúsculas de minúsculas |
| include_files | bool | Não | true | Lista arquivos regulares além de diretórios; links sempre são mostrados, mas nunca seguidos |
| max_entries | int | Não | 10000 | Quantidade máxima de descendentes mantidos, de 1 a 100000 (padrão: 10000) |
Exemplos de entrada
qzx getProjectTreeMostrar o projeto atual até dois níveis de descendentes
qzx getProjectTree src 3Mostrar a árvore de src até três níveis de descendentes
qzx getProjectTree . 2 .git,node_modules false --max_entries 500Mostrar no máximo 500 diretórios ou links e excluir dois nomes
Para obter o payload estruturado completo, adicione --json: qzx getProjectTree [dir_path] [max_depth] [exclude_dirs] [include_files] [max_entries] --json
Exemplo de saída representativa
Este JSON ilustrativo deriva do contrato de resultado respaldado pela implementação atual. Mostra o que o comando pode retornar sem afirmar que seja uma execução gravada; os valores variam conforme entradas, máquina, permissões e ferramentas opcionais.
Comando do exemplo: 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 o 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
}Erros e limites
O contrato público exige success=false e uma message descritiva em caso de falha. Este catálogo ainda não declara uma taxonomia de erros específica para cada comando; revise o resultado e não infira códigos inexistentes.
O QZX está em alpha. Dependências opcionais, permissões e recursos do host podem alterar o resultado.
Fluxo de evidência: pronta para captura automática determinística.
Evidência e procedência
- Implementação
- src/qzx/commands/development/get_project_tree.py
- Canal de documentação
- Documentação de desenvolvimento 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
- Disponibilidade
- 0.2.2.0.9 ou anterior
Continue explorando
Comandos relacionados
Estes comandos também pertencem à categoria desenvolvimento. Compare-os para escolher a operação que melhor resolve sua tarefa.
qzx getGitStatusFornece um resumo estruturado do estado do Git: branch, remoto, alterações e commits recentes.qzx planProjectBootstrapCria um plano selecionável para iniciar um projeto sem gravar arquivos, instalar dependências, criar segredos ou executar migrações.qzx formatCodeDetecta a linguagem e executa o formatador correspondente nos arquivos de código-fonte.qzx prepareReleasePlaneja a atualização dos metadados de uma versão e pode modificar atomicamente um manifesto e CHANGELOG.md; nunca compila, faz commit, cria tag nem publica.