archivos · Referencia de comando

`qzx auditWorkspace`

Qué hace

Crea un plan determinista con huellas de contenido para revisar posibles limpiezas sin alterar el workspace.

Comando canónico: auditWorkspace

Alias aceptados: Ninguno

Distingue mayúsculas: no

Madurez del comando: Alpha

Disponible para uso real y retroalimentación mientras su interfaz y comportamiento todavía pueden evolucionar. Esta es la evaluación actual del checkout de desarrollo. Cada futuro tag inmutable de release conservará la evaluación exacta incluida en esa versión. Disponible en PyPI 0.2.2.0.6a8. La documentación corresponde al checkout alpha 0.2.2.0.6a8.

Seguridad y efectos

Puede modificar estado

Sin parámetro dry-run documentado

No invoca programas nativos según la clasificación

Sin uso de red documentado

No requiere elevación de forma inherente

La auditoría nunca modifica el contenido del workspace. De forma predeterminada es completamente de solo lectura; plan_file puede crear explícitamente un único plan JSON direccionado por contenido y nunca sobrescribe un archivo existente. Los artefactos, logs, respaldos, patrones de nombres, enlaces, entradas especiales y sugerencias de reorganización permanecen únicamente para revisión.

Esta clasificación de seguridad fue revisada por Codex contra el digest de implementación sha256:d13f31382827b9e0607aca8655635394a118b5cf1b481f01b03722b84ddda4ae el 2026-07-30.

Sintaxis exacta

qzx auditWorkspace [path] [categories] [max_files] [plan_file] --json

Parámetros

Desliza o usa la barra horizontal para ver todas las columnas.

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
path	str	No	"."	Directorio del workspace que se auditará
categories	str	No	"build,temp,artifacts,duplicates,reorganizations"	Categorías separadas por comas: build, temp, artifacts, duplicates y reorganizations
max_files	int	No	15000	Cantidad máxima de entradas que no sean directorios que se inspeccionarán
plan_file	str	No	No declarado	Archivo JSON nuevo y opcional en el que se guardará el plan; nunca se sobrescriben archivos existentes

Ejemplos de entrada

qzx auditWorkspace .

Inspeccionar el workspace actual sin escribir ningún archivo

qzx auditWorkspace . --categories build,temp,duplicates --plan-file qzx-repair-plan.json

Guardar un plan de build, temporales y duplicados que repairWorkspace pueda validar posteriormente

Para obtener la carga estructurada completa, añade --json: qzx auditWorkspace [path] [categories] [max_files] [plan_file] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: qzx auditWorkspace . --json

{
    "success": true,
    "message": "Builds a deterministic, fingerprinted workspace cleanup plan without altering workspace contents. In this illustrative example, the command completed successfully.",
    "meta": {
        "command": "auditWorkspace",
        "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
    },
    "details": {
        "path": "C:\\project\\example.txt",
        "workspace_unchanged": true,
        "plan_file": "C:\\project\\example.txt",
        "plan": "Example value"
    },
    "status": "ok"
}

Ver el contrato de resultado JSON

{
    "$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
        },
        "details": {
            "oneOf": [
                {
                    "type": "object",
                    "properties": {
                        "path": [],
                        "workspace_unchanged": {
                            "type": "boolean"
                        },
                        "plan_file": [],
                        "plan": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "path": []
                    },
                    "additionalProperties": true
                },
                {
                    "type": "object",
                    "properties": {
                        "path": [],
                        "plan": [],
                        "plan_file": []
                    },
                    "additionalProperties": true
                }
            ]
        },
        "error": [],
        "error_code": {
            "type": "string"
        },
        "status": {
            "type": "string"
        }
    },
    "additionalProperties": true
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: requiere un destino desechable aislado.

Evidencia y procedencia

Implementación: src/qzx/commands/file/audit_workspace.py
Pruebas: No se encontró un archivo de prueba específico con el mismo nombre de módulo; esto no demuestra ausencia total de cobertura.
Canal de documentación: Documentación de desarrollo 0.2.2.0.6a8 · main · sha256:040df8bbcb6b707bb4cdb7c2c1ad4cc6956ab647a451dc215ea78cdbb4c8ad96
Disponibilidad: 0.2.2.0.6a8 o anterior

Sigue explorando

Estos comandos también pertenecen a la categoría de archivos. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX