系统 · 命令参考
qzx help
作用
显示命令帮助。
命令成熟度：Alpha
可用于真实使用和反馈，但其接口与行为仍可能继续演进。 这是当前开发 checkout 的评估。未来每个不可变发布标签都会保留该版本中包含的准确评估。 可在 PyPI 0.2.2.0.9 使用。文档对应 alpha checkout 0.2.2.0.9。
行为与内置保护
只检查，不改变状态
此操作直接执行
无需调用原生程序即可运行
无需网络即可运行
设计为无需提权即可运行
此安全分类由 OpenAI GPT-5.6 Pro 于 2026-08-25 对照实现摘要 sha256:4871bb678cf16f1fb8023a1641da76fb2c6a7b19d3abc5e51e85a14978a58b81 审阅。
准确语法
qzx help [command] --json参数
滑动或使用横向滚动条查看所有列。
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| command | str | 否 | 未声明 | 要获取帮助的命令名称 |
输入示例
qzx help显示常规帮助信息
qzx help readFile显示 readFile 命令的详细帮助
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 或更早
继续探索
相关命令
这些命令同样属于 系统 类别。对比它们，选择最适合解决任务的操作。