archivos · Referencia de comando

`qzx readFile`

Qué hace

Lee y muestra el contenido de un archivo.

Comando canónico: readFile

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:5f391ea1c2e64ecba1b24e298db374cf6d5e71c1c9af3db52b6a5c99f04ff544 el 2026-07-24.

Sintaxis exacta

qzx readFile <file_path> [max_lines] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
file_path	str	Sí	No declarado	Path to the file to read
max_lines	str	No	No declarado	Maximum number of lines to read (if not provided, reads the entire file)

Ejemplos de entrada

qzx readFile myfile.txt

Read the entire content of myfile.txt

qzx readFile myfile.txt 10

Read the first 10 lines of myfile.txt

qzx readFile "path with spaces/myfile.txt"

Read a file with spaces in the path

Para obtener la carga estructurada completa, añade --json: qzx readFile <file_path> [max_lines] --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 readFile myfile.txt --json

{
    "success": true,
    "message": "Reads and displays the content of a file. In this illustrative example, the command completed successfully.",
    "content": "Example file contents.\nSecond line.",
    "details": {
        "path": "C:\\project\\example.txt"
    }
}

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"
        },
        "content": [],
        "details": {
            "type": "object",
            "properties": {
                "path": []
            },
            "additionalProperties": true
        },
        "error": {
            "type": "string"
        },
        "error_code": {
            "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: lista para captura automática determinista.

Evidencia y procedencia

Implementación: src/qzx/commands/file/read_file.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.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Disponibilidad: 0.2.2.0.2 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