file · Command reference

`qzx findBrokenSymlinks`

What it does

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

Command maturity: Alpha

Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.8. This page documents the 0.2.2.0.8 alpha development checkout.

Behavior and built-in protections

Inspects without changing state

Direct execution for this operation

Works without invoking native programs

Works without network access

No elevation required by design

This safety classification was reviewed by OpenAI GPT-5.6 Pro against implementation digest sha256:b63475e9237e3554ad7ef6d192b19f9c9e4860a5d2df7ac06f06e5e36b276e30 on 2026-08-25.

Exact syntax

qzx findBrokenSymlinks [folder_path] [max_depth] --json

Parameters

Swipe or use the horizontal scrollbar to see every column.

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.",
    "meta": {
        "command": "findBrokenSymlinks",
        "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
    },
    "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",
        "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
        },
        "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.8 · main · sha256:9aa902dfb6b006017e52972bf7871fef49b03ec24ff80741231d743d0354bfc2
Availability: 0.2.2.0.8 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