file · Command reference

`qzx findBrokenSymlinks`

What it does

Scans directories for broken symbolic links (pointing to nonexistent files or folders)

Canonical command: findBrokenSymlinks

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:b32011858a1b0c05e96b5baab324b86b37ced3a99cb577af3b1283c28affd8d8 on 2026-07-25.

Exact syntax

qzx findBrokenSymlinks [folder_path] [max_depth] --json

Parameters

Name	Type	Required	Default	Description
folder_path	str	No	"."	Directory to scan (defaults to current directory)
max_depth	str	No	"4"	Maximum depth level to walk directories recursively (defaults to 4)

Input examples

qzx findBrokenSymlinks

Search for broken symlinks in the current directory

qzx findBrokenSymlinks C:/some/path

Search for broken symlinks in C:/some/path

For the complete structured payload, add --json: qzx findBrokenSymlinks [folder_path] [max_depth] --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 findBrokenSymlinks --json

{
    "success": true,
    "message": "Scans directories for broken symbolic links (pointing to nonexistent files or folders). In this illustrative example, the command completed successfully.",
    "broken_symlinks": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "broken_symlinks_count": 3,
    "scan_path": "C:\\project\\example.txt"
}

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"
        },
        "broken_symlinks": [],
        "broken_symlinks_count": [],
        "error": {
            "type": "string"
        },
        "scan_path": []
    },
    "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/find_broken_symlinks.py
Tests: tests/test_file_commands/test_find_broken_symlinks.py
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