archivos · Referencia de comando
qzx readFile
Qué hace
Lee y muestra el contenido de un archivo.
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.15. La documentación corresponde al checkout alpha 0.2.2.0.15.
Comportamiento y protecciones integradas
Inspecciona sin cambiar el estado
Ejecución directa para esta operación
Funciona sin invocar programas nativos
Funciona sin usar la red
Diseñado para funcionar sin elevación
Esta clasificación de seguridad fue revisada por Claude Opus 5.5 (Anthropic) contra el digest de implementación sha256:b747b8875f49807a91ee577a8604addb5c6fcdd6720c4f89271eddc9fae5fdff el 2026-10-08.
Sintaxis exacta
qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --jsonParámetros
Desliza o usa la barra horizontal para ver todas las columnas.
| Nombre | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
| file_path | str | Sí | No declarado | Ruta del archivo de texto que se leerá |
| max_lines | int | No | No declarado | Máximo de líneas por página; si se omite, no limita las líneas dentro de max_bytes. Cero no lee contenido. |
| max_bytes | int | No | 65536 | Bytes del archivo por página (de 1 a 16777216; predeterminado: 65536), más un sondeo de codificación de cuatro bytes. Los caracteres incompletos quedan para la siguiente página. |
| offset | int | No | 0 | Desplazamiento de bytes desde cero. Usa los valores exactos de next_read para continuar sin repetir ni perder texto. |
| encoding | str | No | "auto" | auto detecta un BOM Unicode; sin BOM exige UTF-8. Admite UTF-8/16/32, ASCII, Latin-1, CP1252, CP437 y CP850 explícitos, con decodificación estricta. |
| expected_fingerprint | str | No | No declarado | Token opcional de huella de metadatos stat obtenido de next_read. Rechaza cambios habituales entre páginas; no es un hash del contenido ni una instantánea inmutable. |
Ejemplos de entrada
qzx readFile myfile.txtLeer hasta 64 KiB de texto conservando Unicode y los saltos de línea originales
qzx readFile myfile.txt 10 --jsonLeer las primeras diez líneas dentro del presupuesto de bytes e inspeccionar next_read
qzx readFile "path with spaces/myfile.txt"Leer un archivo cuya ruta contiene espacios
qzx readFile application.log --max-bytes 4096 --offset 0 --jsonIniciar una lectura acotada de un log; continuar con los valores devueltos en next_read
qzx readFile legacy.txt --encoding cp1252 --jsonLeer un archivo Windows-1252 conocido sin sustituir los caracteres acentuados
Para obtener la carga estructurada completa, añade --json: qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --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.",
"meta": {
"command": "readFile",
"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
},
"content": "Example file contents.\nSecond line.",
"details": {
"summary": "Additional structured context is included here."
}
}Ver el contrato de resultado JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"content": {
"type": "string"
},
"details": {
"type": "object"
},
"error_code": {
"type": "string"
},
"error": {
"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
}
},
"required": [
"message",
"meta",
"success"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"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.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
- Disponibilidad
- 0.2.2.0.15 o anterior
Sigue explorando
Comandos relacionados
Estos comandos también pertenecen a la categoría de archivos. Compáralos para elegir la operación que mejor resuelva tu tarea.
qzx movePathMueve o renombra un archivo, enlace simbólico o directorio completo; rechaza movimientos parciales de directorios.qzx repairWorkspaceValida un plan guardado de auditWorkspace y aplica únicamente las acciones de limpieza seleccionadas que no hayan cambiado.qzx listFilesEnumera archivos de un directorio con comodines y búsqueda recursiva.qzx touchFileCrea un archivo vacío o actualiza la marca de tiempo de uno existente.