desarrollo · Referencia de comando

qzx auditRepository

Qué hace

Ejecuta auditorías de seguridad y calidad en un repositorio Git: secretos, archivos grandes, duplicados, cumplimiento de .gitignore y licencias.

Comando canónico: auditRepository

Alias aceptados: Ninguno

Distingue mayúsculas: no

Incluido en el paquete publicado

Disponible en PyPI 0.2.2.0.2. La documentación corresponde al checkout alpha 0.2.2.0.2.

Seguridad y efectos

Solo lectura según la clasificación actual

Sin parámetro dry-run documentado

Puede invocar programas nativos

Puede usar la red

No requiere elevación de forma inherente

Esta clasificación de seguridad se revisó contra el digest de implementación sha256:b33b42051061857bfa5a74af37e6f5f103d365a4d47267c83791f5c7a1558cf3 el 2026-07-24.

Sintaxis exacta

qzx auditRepository [path] --json

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
pathstrNo"."Path to the repository to audit (default: '.')

Ejemplos de entrada

qzx auditRepository

Audit the current repository

qzx auditRepository C:/other/project

Audit project at specified path

Para obtener la carga estructurada completa, añade --json: qzx auditRepository [path] --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 auditRepository --json

{
    "success": true,
    "message": "Runs security and quality audits on a Git repository (secrets, large files, duplicates, .gitignore compliance, licenses). In this illustrative example, the command completed successfully.",
    "details": {
        "summary": "Additional structured context is included here."
    }
}
Ver el contrato de resultado JSON
{
    "$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
}

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 endpoint autorizado o una fixture revisada.

Evidencia y procedencia

Canal de documentación
Documentación de desarrollo 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Disponibilidad
0.2.2.0.2 o anterior

Sigue explorando

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

Explorar todos los comandos de QZX