ファイル · コマンドリファレンス
qzx readFile
機能
ファイルの内容を読み取って表示します。
コマンドの成熟度: Alpha
実際の利用とフィードバックに使えますが、インターフェースと動作はまだ変更される可能性があります。 これは現在の開発チェックアウトに対する評価です。今後の各不変リリースタグには、そのバージョンに含まれた正確な評価が保存されます。 PyPI 0.2.2.0.15 で利用できます。ドキュメントは alpha チェックアウト 0.2.2.0.15 に対応しています。
動作と組み込み保護
状態を変更せずに検査します
この操作は直接実行されます
ネイティブプログラムを呼び出さずに動作します
ネットワークを使わずに動作します
権限昇格なしで動作するよう設計されています
この安全分類は 2026-10-08 に Claude Opus 5.5 (Anthropic) が実装ダイジェスト sha256:b747b8875f49807a91ee577a8604addb5c6fcdd6720c4f89271eddc9fae5fdff と照合してレビューしました。
正確な構文
qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --jsonパラメータ
スワイプするか横スクロールバーを使って、すべての列を表示してください。
| 名前 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
| file_path | str | はい | 未宣言 | 読み取るテキストファイルのパス |
| max_lines | int | いいえ | 未宣言 | 1ページの最大行数。省略すると max_bytes の範囲内で行数を制限しません。0 の場合は内容を読み取りません。 |
| max_bytes | int | いいえ | 65536 | 1ページの元ファイルのバイト数（1〜16777216、既定値65536）。符号化判定のためにさらに4バイト読み取ります。不完全な文字は次のページに残します。 |
| offset | int | いいえ | 0 | 0から始まる元ファイルのバイト位置。テキストの重複や欠落を避けるため、next_read の値をそのまま使って続行してください。 |
| encoding | str | いいえ | "auto" | auto は Unicode BOM を検出し、BOM がなければ UTF-8 を要求します。UTF-8/16/32、ASCII、Latin-1、CP1252、CP437、CP850 を明示的に指定でき、厳密にデコードします。 |
| expected_fingerprint | str | いいえ | 未宣言 | next_read から取得する任意の stat メタデータ指紋トークン。ページ間の通常のファイル変更を拒否します。内容のハッシュや不変のスナップショットではありません。 |
入力例
qzx readFile myfile.txtUnicode と元の改行を保ったまま、最大64 KiBのテキストを読み取る
qzx readFile myfile.txt 10 --jsonバイト数の上限内で先頭10行を読み取り、next_read を確認する
qzx readFile "path with spaces/myfile.txt"パスに空白を含むファイルを読み取る
qzx readFile application.log --max-bytes 4096 --offset 0 --jsonログの読み取りを制限付きで開始し、返された next_read の値で続行する
qzx readFile legacy.txt --encoding cp1252 --jsonWindows-1252 と分かっているファイルを、アクセント付き文字を置換せずに読み取る
完全な構造化ペイロードを取得するには --json を追加します: qzx readFile <file_path> [max_lines] [max_bytes] [offset] [encoding] [expected_fingerprint] --json
代表的な出力例
この説明用 JSON は現在の実装が裏付ける結果コントラクトから生成されています。記録された実行だと主張せず、コマンドが返し得る内容を示します。値は入力、マシン、権限、オプションツールによって変わります。
例のコマンド: 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."
}
}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
}エラーと制限
公開コントラクトでは失敗時に success=false と説明的な message が必要です。このカタログではまだコマンドごとのエラー分類を宣言していません。結果を確認し、存在しないコードを推測しないでください。
QZX は alpha 段階です。オプション依存関係、権限、ホスト機能によって結果が変わる場合があります。
証拠フロー: 決定論的な自動取得が可能。
証拠と出所
- テスト
- 同じモジュール名の専用テストファイルは見つかりませんでしたが、テストカバレッジがまったくないことを示すものではありません。
- ドキュメントチャネル
- 開発ドキュメント 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
- 提供状況
- 0.2.2.0.15 以前
さらに探す
関連コマンド
これらのコマンドも ファイル カテゴリに属します。比較して、タスクに最適な操作を選んでください。