file · Command reference

`qzx isDirectoryEmpty`

What it does

Checks if a directory is empty (contains no files or subdirectories)

Canonical command: isDirectoryEmpty

Accepted aliases: wonderIfDirectoryEmpty

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:5102efe44647efadae88c6b3eca3711fb8b22e54a761d8c8aed2fa8501e3642d on 2026-07-24.

Exact syntax

qzx isDirectoryEmpty <directory_path> [include_hidden] --json

Parameters

Name	Type	Required	Default	Description
directory_path	str	Yes	Not declared	Path to the directory to check
include_hidden	bool	No	false	Whether to include hidden files in the check

Input examples

qzx wonderIfDirectoryEmpty /path/to/directory

Check if /path/to/directory is empty, ignoring hidden files

qzx wonderIfDirectoryEmpty /path/to/directory true

Check if /path/to/directory is empty, including hidden files

For the complete structured payload, add --json: qzx isDirectoryEmpty <directory_path> [include_hidden] --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 wonderIfDirectoryEmpty /path/to/directory --json

{
    "success": true,
    "message": "Checks if a directory is empty (contains no files or subdirectories). In this illustrative example, the command completed successfully.",
    "directory_count": 3,
    "directory_path": "C:\\project\\example.txt",
    "file_count": 3,
    "include_hidden": true,
    "is_empty": false,
    "item_count": 3
}

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_count": [],
        "directory_path": [],
        "error": {
            "type": "string"
        },
        "file_count": [],
        "include_hidden": [],
        "is_empty": [],
        "item_count": []
    },
    "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/is_directory_empty.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