arquivos · Referência do comando

`qzx readFile`

O que faz

Lê e mostra o conteúdo de um arquivo.

Maturidade do comando: Alpha

Disponível para uso real e feedback enquanto a interface e o comportamento ainda podem evoluir. Esta é a avaliação atual do checkout de desenvolvimento. Cada tag de release imutável futuro preservará a avaliação exata incluída nessa versão. Disponível no PyPI 0.2.2.0.15. A documentação corresponde ao checkout alpha 0.2.2.0.15.

Comportamento e proteções integradas

Inspeciona sem alterar o estado

Execução direta para esta operação

Funciona sem invocar programas nativos

Funciona sem usar a rede

Projetado para funcionar sem elevação

Esta classificação de segurança foi revisada por Claude Opus 5.5 (Anthropic) em relação ao digest de implementação sha256:b747b8875f49807a91ee577a8604addb5c6fcdd6720c4f89271eddc9fae5fdff em 2026-10-08.

Sintaxe exata

qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --json

Parâmetros

Deslize ou use a barra horizontal para ver todas as colunas.

Nome	Tipo	Obrigatório	Padrão	Descrição
file_path	str	Sim	Não declarado	Caminho do arquivo de texto a ser lido
max_lines	int	Não	Não declarado	Máximo de linhas por página; se omitido, não limita as linhas dentro de max_bytes. Zero não lê conteúdo.
max_bytes	int	Não	65536	Bytes do arquivo por página (de 1 a 16777216; padrão: 65536), mais uma sondagem de codificação de quatro bytes. Caracteres incompletos ficam para a próxima página.
offset	int	Não	0	Deslocamento de bytes a partir de zero. Use os valores exatos de next_read para continuar sem repetir nem perder texto.
encoding	str	Não	"auto"	auto detecta um BOM Unicode; sem BOM, exige UTF-8. Aceita UTF-8/16/32, ASCII, Latin-1, CP1252, CP437 e CP850 explícitos, com decodificação estrita.
expected_fingerprint	str	Não	Não declarado	Token opcional de impressão dos metadados stat obtido de next_read. Rejeita alterações comuns entre páginas; não é um hash do conteúdo nem uma captura imutável.

Exemplos de entrada

qzx readFile myfile.txt

Ler até 64 KiB de texto preservando Unicode e as quebras de linha originais

qzx readFile myfile.txt 10 --json

Ler as primeiras dez linhas dentro do limite de bytes e examinar next_read

qzx readFile "path with spaces/myfile.txt"

Ler um arquivo cujo caminho contém espaços

qzx readFile application.log --max-bytes 4096 --offset 0 --json

Iniciar uma leitura limitada de um log; continuar com os valores retornados em next_read

qzx readFile legacy.txt --encoding cp1252 --json

Ler um arquivo Windows-1252 conhecido sem substituir os caracteres acentuados

Para obter o payload estruturado completo, adicione --json: qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --json

Exemplo de saída representativa

Este JSON ilustrativo deriva do contrato de resultado respaldado pela implementação atual. Mostra o que o comando pode retornar sem afirmar que seja uma execução gravada; os valores variam conforme entradas, máquina, permissões e ferramentas opcionais.

Comando do exemplo: 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 o 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
}

Erros e limites

O contrato público exige success=false e uma message descritiva em caso de falha. Este catálogo ainda não declara uma taxonomia de erros específica para cada comando; revise o resultado e não infira códigos inexistentes.

O QZX está em alpha. Dependências opcionais, permissões e recursos do host podem alterar o resultado.

Fluxo de evidência: pronta para captura automática determinística.

Evidência e procedência

Implementação: src/qzx/commands/file/read_file.py
Testes: Não foi encontrado um arquivo de teste específico com o mesmo nome do módulo; isso não demonstra ausência total de cobertura.
Canal de documentação: Documentação de desenvolvimento 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
Disponibilidade: 0.2.2.0.15 ou anterior

Continue explorando

Estes comandos também pertencem à categoria arquivos. Compare-os para escolher a operação que melhor resolve sua tarefa.

Explorar todos os comandos do QZX