desarrollo · Referencia de comando

`qzx deployProject`

Qué hace

Gestiona build local, respaldo remoto, sincronización, permisos, recarga de servicio, comprobación de salud y rollback automático.

Comando canónico: deployProject

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

Puede modificar estado

Parámetro dry-run documentado

Puede invocar programas nativos

Puede usar la red

El resultado puede depender de permisos

Applying a deployment sends local build artifacts to the operator-selected SSH target. It must create a remote backup before synchronization and roll back when the health check fails.

Antes de mutar, QZX crea un archivo de recuperación; --dangerously-bypass-approvals-and-sandbox/--yolo lo omite explícitamente.

Este comando comparte los datos documentados con un servicio externo.

Esta clasificación de seguridad se revisó contra el digest de implementación sha256:19b3f10d45060d4e618ce54120bbbe95f80374a4663a3b193b7e4ad4ff754173 el 2026-07-25.

Sintaxis exacta

qzx deployProject <target_host> [path] <target_path> [port] [ssh_key] [health_url] [restart_cmd] [skip_build] [dry_run] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
target_host	str	Sí	No declarado	Target SSH host (e.g. [email protected] or hostname)
path	str	No	"."	Path to local project root directory (default: '.')
target_path	str	Sí	No declarado	Target path on remote host (e.g. /var/www/html/)
port	int	No	22	SSH Port (default: 22)
ssh_key	str	No	No declarado	Path to SSH Private Key (optional)
health_url	str	No	No declarado	Health check URL (optional)
restart_cmd	str	No	No declarado	Remote command to restart service (e.g. nginx -s reload, pm2 restart all) (optional)
skip_build	bool	No	false	If True, skip running local build scripts (default: False)
dry_run	bool	No	true	If True, only show commands that would be executed without running them (default: True)

Ejemplos de entrada

qzx deployProject --target_host [email protected] --target_path /var/www/html/ --port 2237

Previews deployment of the current workspace

qzx deployProject --target_host deploy@host --target_path /var/www/html/ --health_url https://site.com --dry_run True

Simulates project deployment with health check

qzx deployProject --target_host deploy@host --target_path /var/www/html/ --dry_run false

Backs up the local project and executes deployment

Para obtener la carga estructurada completa, añade --json: qzx deployProject <target_host> [path] <target_path> [port] [ssh_key] [health_url] [restart_cmd] [skip_build] [dry_run] --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 deployProject --target_host [email protected] --target_path /var/www/html/ --port 2237 --json

{
    "success": true,
    "message": "Handles local build, remote backup, synchronization, permission setup, service reload, health check, and automatic rollback on failure. 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

Implementación: src/qzx/commands/development/deploy_project.py
Pruebas: tests/test_development_commands/test_deploy_project.py
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