file · Command reference

`qzx repairWorkspace`

What it does

Scans, reorganizes, and cleans temporary files, build directories, binary artifacts, and duplicate files. (Safe dry-run by default)

Canonical command: repairWorkspace

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

Can mutate state

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

Exact syntax

qzx repairWorkspace [path] [dry_run] [categories] [apply] --json

Parameters

Name	Type	Required	Default	Description
path	str	No	"."	Directory path to scan and clean (default: '.')
dry_run	bool	No	true	If True, only show what would be done without modifying any files (default: True)
categories	str	No	"build,temp,artifacts,duplicates,reorganizations"	List of categories to clean: build, temp, artifacts, duplicates, reorganizations (default: all)
apply	bool	No	false	Must be True alongside dry_run=False to actually delete/modify files (default: False)

Input examples

qzx repairWorkspace

Scan the workspace for build directories, temp files, duplicates, and reorganizations (dry-run)

qzx repairWorkspace --dry_run False --apply True

Actually delete/clean and reorganize the detected files

For the complete structured payload, add --json: qzx repairWorkspace [path] [dry_run] [categories] [apply] --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 repairWorkspace --json

{
    "success": true,
    "message": "Scans, reorganizes, and cleans temporary files, build directories, binary artifacts, and duplicate files. (Safe dry-run by default). In this illustrative example, the command completed successfully.",
    "details": {
        "summary": "Additional structured context is included here."
    }
}

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"
        },
        "details": [],
        "error": {
            "type": "string"
        }
    },
    "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: requires an isolated disposable target.

Evidence and provenance

Implementation: src/qzx/commands/file/repair_workspace.py
Tests: tests/test_file_commands/test_repair_workspace.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