archivos · Referencia de comando

`qzx listFiles`

Qué hace

Enumera archivos de un directorio con comodines y búsqueda recursiva.

Comando canónico: listFiles

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:151a5807d2333a45ae33a60fb70df0d9ff77725344ef5957d4c6d98196df687d el 2026-07-24.

Sintaxis exacta

qzx listFiles [directory_path] [pattern] [recursive] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
directory_path	str	No	"."	Path to the directory to list files from
pattern	str	No	"*"	File pattern to filter by (e.g., ".txt", "doc.pdf")
recursive	str	No	No declarado	Recursion level: none by default, -r/--recursive for unlimited depth, -rN/--recursiveN for N levels deep

Ejemplos de entrada

qzx listFiles

List all files in the current directory

qzx listFiles C:\Documents

List all files in the C:\Documents directory (Windows)

qzx listFiles /home/user/documents

List all files in the /home/user/documents directory (Linux/Mac)

qzx listFiles . "*.py"

List all Python files in the current directory

qzx listFiles src "*.js" -r

List all JavaScript files in the src directory and all its subdirectories

qzx listFiles src "*.js" -r2

List all JavaScript files in the src directory and up to 2 levels of subdirectories

Para obtener la carga estructurada completa, añade --json: qzx listFiles [directory_path] [pattern] [recursive] --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 listFiles --json

{
    "success": true,
    "message": "Lists files in a directory with support for wildcards and recursive searching. In this illustrative example, the command completed successfully.",
    "directory": "C:\\project\\example.txt",
    "files": [
        {
            "path": "src/example.py",
            "size_readable": "4.2 KiB"
        }
    ],
    "pattern": "Example value",
    "recursive": true
}

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"
        },
        "directory": [],
        "files": {
            "type": "array"
        },
        "pattern": [],
        "recursive": []
    },
    "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/file/list_files.py
Pruebas: No se encontró un archivo de prueba específico con el mismo nombre de módulo; esto no demuestra ausencia total de cobertura.
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

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

Explorar todos los comandos de QZX