システム · コマンドリファレンス
qzx help
機能
コマンドのヘルプを表示します。
コマンドの成熟度: Alpha
実際の利用とフィードバックに使えますが、インターフェースと動作はまだ変更される可能性があります。 これは現在の開発チェックアウトに対する評価です。今後の各不変リリースタグには、そのバージョンに含まれた正確な評価が保存されます。 PyPI 0.2.2.0.9 で利用できます。ドキュメントは alpha チェックアウト 0.2.2.0.9 に対応しています。
動作と組み込み保護
状態を変更せずに検査します
この操作は直接実行されます
ネイティブプログラムを呼び出さずに動作します
ネットワークを使わずに動作します
権限昇格なしで動作するよう設計されています
この安全分類は 2026-08-25 に OpenAI GPT-5.6 Pro が実装ダイジェスト sha256:4871bb678cf16f1fb8023a1641da76fb2c6a7b19d3abc5e51e85a14978a58b81 と照合してレビューしました。
正確な構文
qzx help [command] --jsonパラメータ
スワイプするか横スクロールバーを使って、すべての列を表示してください。
| 名前 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
| command | str | いいえ | 未宣言 | ヘルプを取得するコマンド名 |
入力例
qzx help一般的なヘルプ情報を表示
qzx help readFilereadFile コマンドの詳細ヘルプを表示
qzx readFile --helpコマンドの通常フラグで同じヘルプを表示
完全な構造化ペイロードを取得するには --json を追加します: qzx help [command] --json
観測された出力例
Windows 11 上の QZX 0.2.2.0.9 で取得。終了コードは 0。ホスト依存の値や所要時間は変わる場合があります。
例のコマンド: qzx help findFiles --json
{
"success": true,
"command": "findFiles",
"message": "Command: findFiles\nDescription: Finds files by name, depth, size, and modification date with structured metadata\nMaturity: Alpha\n Available for real use and feedback while its interface and behavior can still evolve.\n\nParameters:\n - search_path: Directory where the search starts [Optional (Default: .)]\n - pattern: File name glob such as *.txt or data-???.csv; defaults to all files [Optional (Default: *)]\n - recursive: Search depth: -r for unlimited, false for this directory only, or -rN for N levels [Optional (Default: -r)]\n - min_size: Minimum size, for example 500KB, 10MiB, or bytes [Optional]\n - max_size: Maximum size, for example 2GB, 20MiB, or bytes [Optional]\n - modified_after: Only files modified at or after YYYY-MM-DD, \"today\", or \"yesterday\" [Optional]\n - modified_before: Only files modified before YYYY-MM-DD, \"today\", or \"yesterday\" [Optional]\n - exclude: Comma-separated file-name globs to exclude [Optional]\n - exclude_dirs: Comma-separated directory-name globs to skip [Optional]\n - sort_by: Sort by path, name, size, or modified [Optional (Default: path)]\n - descending: Reverse the selected sort order (true/false) [Optional (Default: False)]\n - limit: Maximum number of files returned after sorting [Optional]\n\nExamples:\n qzx findFiles . \"*.py\" --exclude-dirs \".git,.venv\"\n Find Python files recursively while skipping common metadata directories\n qzx findFiles Downloads \"*\" --min-size 100MiB --sort-by size --descending true --limit 20\n Return the 20 largest matching files of at least 100 MiB\n qzx findFiles logs \"*.log\" --modified-after 2026-07-01 --recursive false\n Find recently modified log files in one directory\n",
"details": {
"name": "findFiles",
"requested_name": "findFiles",
"canonical_name": "findFiles",
"description": "Finds files by name, depth, size, and modification date with structured metadata",
"category": "file",
"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"
},
"parameters": [
{
"name": "search_path",
"description": "Directory where the search starts",
"required": false,
"default": "."
},
{
"name": "pattern",
"description": "File name glob such as *.txt or data-???.csv; defaults to all files",
"required": false,
"default": "*"
},
{
"name": "recursive",
"description": "Search depth: -r for unlimited, false for this directory only, or -rN for N levels",
"required": false,
"default": "-r"
},
{
"name": "min_size",
"description": "Minimum size, for example 500KB, 10MiB, or bytes",
"required": false,
"default": null
},
{
"name": "max_size",
"description": "Maximum size, for example 2GB, 20MiB, or bytes",
"required": false,
"default": null
},
{
"name": "modified_after",
"description": "Only files modified at or after YYYY-MM-DD, \"today\", or \"yesterday\"",
"required": false,
"default": null
},
{
"name": "modified_before",
"description": "Only files modified before YYYY-MM-DD, \"today\", or \"yesterday\"",
"required": false,
"default": null
},
{
"name": "exclude",
"description": "Comma-separated file-name globs to exclude",
"required": false,
"default": null
},
{
"name": "exclude_dirs",
"description": "Comma-separated directory-name globs to skip",
"required": false,
"default": null
},
{
"name": "sort_by",
"description": "Sort by path, name, size, or modified",
"required": false,
"default": "path"
},
{
"name": "descending",
"description": "Reverse the selected sort order (true/false)",
"required": false,
"default": false
},
{
"name": "limit",
"description": "Maximum number of files returned after sorting",
"required": false,
"default": null
}
],
"examples": [
{
"command": "qzx findFiles . \"*.py\" --exclude-dirs \".git,.venv\"",
"description": "Find Python files recursively while skipping common metadata directories"
},
{
"command": "qzx findFiles Downloads \"*\" --min-size 100MiB --sort-by size --descending true --limit 20",
"description": "Return the 20 largest matching files of at least 100 MiB"
},
{
"command": "qzx findFiles logs \"*.log\" --modified-after 2026-07-01 --recursive false",
"description": "Find recently modified log files in one directory"
}
]
},
"meta": {
"command": "help",
"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": 9.04,
"schema_version": 1
}
}JSON 結果コントラクトを見る
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"success",
"message",
"meta"
],
"properties": {
"success": {
"type": "boolean"
},
"message": {
"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
},
"command": [],
"details": {
"oneOf": [
{
"type": "object",
"properties": {
"requested": [],
"suggestions": []
},
"additionalProperties": true
},
{
"type": "object",
"properties": {
"name": [],
"requested_name": [],
"canonical_name": [],
"description": [],
"category": [],
"maturity": [],
"parameters": [],
"examples": []
},
"additionalProperties": true
}
]
},
"error": {
"type": "string"
},
"error_code": {
"type": "string"
}
},
"additionalProperties": true
}エラーと制限
公開コントラクトでは失敗時に success=false と説明的な message が必要です。このカタログではまだコマンドごとのエラー分類を宣言していません。結果を確認し、存在しないコードを推測しないでください。
QZX は alpha 段階です。オプション依存関係、権限、ホスト機能によって結果が変わる場合があります。
{
"success": false,
"error": "Command not found: definitelyMissingGoldenCoreCommand",
"error_code": "command_not_found",
"message": "Command 'definitelyMissingGoldenCoreCommand' was not found. Use 'qzx listCommands' to see available commands.",
"details": {
"requested": "definitelyMissingGoldenCoreCommand",
"suggestions": []
},
"meta": {
"command": "help",
"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": 9.376,
"schema_version": 1
}
}取得したコマンド: qzx help definitelyMissingGoldenCoreCommand --json
証拠フロー: 取得済み・ダイジェストで検証済み。
証拠と出所
- ドキュメントチャネル
- 開発ドキュメント 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
- 提供状況
- 0.2.2.0.9 以前
さらに探す
関連コマンド
これらのコマンドも システム カテゴリに属します。比較して、タスクに最適な操作を選んでください。