desarrollo · Referencia de comando

`qzx traceEnvVar`

Qué hace

Rastrea el uso de una variable de entorno en código, .env y plantillas .env.example.

Comando canónico: traceEnvVar

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

No invoca programas nativos según la clasificación

Sin uso de red documentado

No requiere elevación de forma inherente

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

Sintaxis exacta

qzx traceEnvVar <var_name> [project_path] [recursive] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
var_name	str	Sí	No declarado	Name of the environment variable to search for (e.g. DATABASE_URL, PORT)
project_path	str	No	"."	Path to the project root directory (defaults to current directory)
recursive	bool	No	true	Whether to search directories recursively (defaults to True)

Ejemplos de entrada

qzx traceEnvVar "PORT"

Trace usage of the PORT environment variable in the current directory

qzx traceEnvVar "STRIPE_API_KEY" "C:/my-project"

Trace usage of STRIPE_API_KEY in C:/my-project

Para obtener la carga estructurada completa, añade --json: qzx traceEnvVar <var_name> [project_path] [recursive] --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 traceEnvVar "PORT" --json

{
    "success": true,
    "message": "Traces usage of an environment variable across code files, .env, and .env.example templates. In this illustrative example, the command completed successfully.",
    "env_files_diagnostics": "C:\\project\\example.txt",
    "project_path": "C:\\project\\example.txt",
    "references": [
        {
            "path": "src/settings.py",
            "line": 12,
            "context": "API_URL = os.getenv(\"API_URL\")"
        }
    ],
    "references_count": 3,
    "var_name": "Example value"
}

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"
        },
        "env_files_diagnostics": [],
        "error": {
            "type": "string"
        },
        "project_path": [],
        "references": [],
        "references_count": [],
        "var_name": []
    },
    "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: lista para captura automática determinista.

Evidencia y procedencia

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