file · Command reference

`qzx listFiles`

What it does

Lists files in a directory with support for wildcards and recursive searching

Canonical command: listFiles

Accepted aliases: None

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Read-only under the current classification

No documented dry-run parameter

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:151a5807d2333a45ae33a60fb70df0d9ff77725344ef5957d4c6d98196df687d on 2026-07-24.

Exact syntax

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

Parameters

Name	Type	Required	Default	Description
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	Not declared	Recursion level: none by default, -r/--recursive for unlimited depth, -rN/--recursiveN for N levels deep

Input examples

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

For the complete structured payload, add --json: qzx listFiles [directory_path] [pattern] [recursive] --json

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 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
}

View the JSON result contract

{
    "$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
}

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.

Evidence and provenance

Implementation: src/qzx/commands/file/list_files.py
Tests: No command-specific test file with the same module name was found; this does not prove that all coverage is absent.
Documentation channel: Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability: 0.2.2.0.2 or earlier

Keep exploring

These commands also belong to the file category. Compare them to choose the operation that best fits your task.

Explore all QZX commands